Package com.azure.analytics.purview.scanning

Class ScansClient

java.lang.Object

com.azure.analytics.purview.scanning.ScansClient

public final class ScansClient
extends Object

Initializes a new instance of the synchronous PurviewScanningClient type.

Method Summary

Modifier and Type	Method	Description
Response<BinaryData>	createOrUpdateWithResponse(String dataSourceName, String scanName, BinaryData body, RequestOptions requestOptions)	Creates an instance of a scan.
Response<BinaryData>	deleteWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions)	Deletes the scan associated with the data source.
Response<BinaryData>	getWithResponse(String dataSourceName, String scanName, RequestOptions requestOptions)	Gets a scan information.
PagedIterable<BinaryData>	listByDataSource(String dataSourceName, RequestOptions requestOptions)	List scans in data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createOrUpdateWithResponse

public 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.

Throws:

HttpResponseException - thrown if the request is rejected by server.

getWithResponse

public 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.

Throws:

HttpResponseException - thrown if the request is rejected by server.

deleteWithResponse

public 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.

Throws:

HttpResponseException - thrown if the request is rejected by server.

listByDataSource

public PagedIterable<BinaryData> listByDataSource(String dataSourceName,
 RequestOptions requestOptions)

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.