Class ScansAsyncClient
java.lang.Object
com.azure.analytics.purview.scanning.ScansAsyncClient
Initializes a new instance of the asynchronous PurviewScanningClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdateWithResponse
(String dataSourceName, String scanName, BinaryData body, RequestOptions requestOptions) Creates an instance of a scan.deleteWithResponse
(String dataSourceName, String scanName, RequestOptions requestOptions) Deletes the scan associated with the data source.getWithResponse
(String dataSourceName, String scanName, RequestOptions requestOptions) Gets a scan information.listByDataSource
(String dataSourceName, RequestOptions requestOptions) List scans in data source.
-
Method Details
-
createOrUpdateWithResponse
public Mono<Response<BinaryData>> createOrUpdateWithResponse(String dataSourceName, String scanName, BinaryData body, RequestOptions requestOptions) Creates an instance of a scan.Query Parameters
Query Parameters Name Type Required Description apiVersion String Yes Api Version Request Body Schema
{ id: String name: String scanResults: [ { parentId: String id: String resourceId: String status: String assetsDiscovered: Long assetsClassified: Long diagnostics: { notifications: [ { message: String code: Integer } ] exceptionCountMap: { String: int } } startTime: String queuedTime: String pipelineStartTime: String endTime: String scanRulesetVersion: Integer scanRulesetType: String(Custom/System) scanLevelType: String(Full/Incremental) errorMessage: String error: { code: String message: String target: String details: [ { code: String message: String target: String details: [ (recursive schema, see above) ] } ] } runType: String dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI) } ] }
Response Body Schema
{ id: String name: String scanResults: [ { parentId: String id: String resourceId: String status: String assetsDiscovered: Long assetsClassified: Long diagnostics: { notifications: [ { message: String code: Integer } ] exceptionCountMap: { String: int } } startTime: String queuedTime: String pipelineStartTime: String endTime: String scanRulesetVersion: Integer scanRulesetType: String(Custom/System) scanLevelType: String(Full/Incremental) errorMessage: String error: { code: String message: String target: String details: [ { code: String message: String target: String details: [ (recursive schema, see above) ] } ] } runType: String dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI) } ] }
- Parameters:
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.body
- The body parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the response body along with
Response
on successful completion ofMono
. - Throws:
HttpResponseException
- thrown if the request is rejected by server.
-
getWithResponse
public Mono<Response<BinaryData>> getWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions) Gets a scan information.Query Parameters
Query Parameters Name Type Required Description apiVersion String Yes Api Version Response Body Schema
{ id: String name: String scanResults: [ { parentId: String id: String resourceId: String status: String assetsDiscovered: Long assetsClassified: Long diagnostics: { notifications: [ { message: String code: Integer } ] exceptionCountMap: { String: int } } startTime: String queuedTime: String pipelineStartTime: String endTime: String scanRulesetVersion: Integer scanRulesetType: String(Custom/System) scanLevelType: String(Full/Incremental) errorMessage: String error: { code: String message: String target: String details: [ { code: String message: String target: String details: [ (recursive schema, see above) ] } ] } runType: String dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI) } ] }
- Parameters:
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- a scan information along with
Response
on successful completion ofMono
. - Throws:
HttpResponseException
- thrown if the request is rejected by server.
-
deleteWithResponse
public Mono<Response<BinaryData>> deleteWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions) Deletes the scan associated with the data source.Query Parameters
Query Parameters Name Type Required Description apiVersion String Yes Api Version Response Body Schema
{ id: String name: String scanResults: [ { parentId: String id: String resourceId: String status: String assetsDiscovered: Long assetsClassified: Long diagnostics: { notifications: [ { message: String code: Integer } ] exceptionCountMap: { String: int } } startTime: String queuedTime: String pipelineStartTime: String endTime: String scanRulesetVersion: Integer scanRulesetType: String(Custom/System) scanLevelType: String(Full/Incremental) errorMessage: String error: { code: String message: String target: String details: [ { code: String message: String target: String details: [ (recursive schema, see above) ] } ] } runType: String dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI) } ] }
- Parameters:
dataSourceName
- The dataSourceName parameter.scanName
- The scanName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the response body along with
Response
on successful completion ofMono
. - Throws:
HttpResponseException
- thrown if the request is rejected by server.
-
listByDataSource
List scans in data source.Query Parameters
Query Parameters Name Type Required Description apiVersion String Yes Api Version Response Body Schema
{ value: [ { id: String name: String scanResults: [ { parentId: String id: String resourceId: String status: String assetsDiscovered: Long assetsClassified: Long diagnostics: { notifications: [ { message: String code: Integer } ] exceptionCountMap: { String: int } } startTime: String queuedTime: String pipelineStartTime: String endTime: String scanRulesetVersion: Integer scanRulesetType: String(Custom/System) scanLevelType: String(Full/Incremental) errorMessage: String error: { code: String message: String target: String details: [ { code: String message: String target: String details: [ (recursive schema, see above) ] } ] } runType: String dataSourceType: String(None/AzureSubscription/AzureResourceGroup/AzureSynapseWorkspace/AzureSynapse/AdlsGen1/AdlsGen2/AmazonAccount/AmazonS3/AmazonSql/AzureCosmosDb/AzureDataExplorer/AzureFileService/AzureSqlDatabase/AmazonPostgreSql/AzurePostgreSql/SqlServerDatabase/AzureSqlDatabaseManagedInstance/AzureSqlDataWarehouse/AzureMySql/AzureStorage/Teradata/Oracle/SapS4Hana/SapEcc/PowerBI) } ] } ] nextLink: String count: Long }
- Parameters:
dataSourceName
- The dataSourceName parameter.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the response.
- Throws:
HttpResponseException
- thrown if the request is rejected by server.
-