ScansOperations Class

ScansOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ScansOperations

Constructor

ScansOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

create_or_update	Creates an instance of a scan.
delete	Deletes the scan associated with the data source.
get	Gets a scan information.
list_by_data_source	List scans in data source.

create_or_update

Creates an instance of a scan.

create_or_update(data_source_name: str, scan_name: str, body: Any, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

body

<xref:Any>

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   kind = 'AdlsGen1CredentialScan' or 'AdlsGen1MsiScan' or 'AdlsGen2CredentialScan' or 'AdlsGen2MsiScan' or 'AmazonAccountCredentialScan' or 'AmazonPostgreSqlCredentialScan' or 'AmazonS3CredentialScan' or 'AmazonS3RoleARNScan' or 'AmazonSqlCredentialScan' or 'AzureCosmosDbCredentialScan' or 'AzureDataExplorerCredentialScan' or 'AzureDataExplorerMsiScan' or 'AzureFileServiceCredentialScan' or 'AzureMySqlCredentialScan' or 'AzurePostgreSqlCredentialScan' or 'AzureResourceGroupCredentialScan' or 'AzureResourceGroupMsiScan' or 'AzureSqlDataWarehouseCredentialScan' or 'AzureSqlDataWarehouseMsiScan' or 'AzureSqlDatabaseCredentialScan' or 'AzureSqlDatabaseManagedInstanceCredentialScan' or 'AzureSqlDatabaseManagedInstanceMsiScan' or 'AzureSqlDatabaseMsiScan' or 'AzureStorageCredentialScan' or 'AzureStorageMsiScan' or 'AzureSubscriptionCredentialScan' or 'AzureSubscriptionMsiScan' or 'AzureSynapseCredentialScan' or 'AzureSynapseMsiScan' or 'AzureSynapseWorkspaceCredentialScan' or 'AzureSynapseWorkspaceMsiScan' or 'OracleCredentialScan' or 'OracleUserPassScan' or 'PowerBIDelegatedScan' or 'PowerBIMsiScan' or 'SapEccCredentialScan' or 'SapEccUserPassScan' or 'SapS4HanaSapS4HanaCredentialScan' or 'SapS4HanaSapS4HanaUserPassScan' or 'SqlServerDatabaseCredentialScan' or 'TeradataCredentialScan' or 'TeradataUserPassScanAutoGenerated' or 'TeradataUserPassScan'

   # JSON input template you can fill out and use as your body input.
   body = {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "scanResults": [
           {
               "assetsClassified": 0.0,  # Optional.
               "assetsDiscovered": 0.0,  # Optional.
               "dataSourceType": "str",  # Optional. Possible values include: "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".
               "diagnostics": {
                   "exceptionCountMap": {
                       "str": 0  # Optional. Dictionary of :code:`<integer>`.
                   },
                   "notifications": [
                       {
                           "code": 0,  # Optional.
                           "message": "str"  # Optional.
                       }
                   ]
               },
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "error": {
                   "code": "str",  # Optional.
                   "details": [
                       {
                           "code": "str",  # Optional.
                           "details": [
                               ...
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       }
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               },
               "errorMessage": "str",  # Optional.
               "id": "str",  # Optional.
               "parentId": "str",  # Optional.
               "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
               "queuedTime": "2020-02-20 00:00:00",  # Optional.
               "resourceId": "str",  # Optional.
               "runType": "str",  # Optional.
               "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "scanRulesetVersion": 0,  # Optional.
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "status": "str"  # Optional.
           }
       ],
       kind: Scan
   }

   # response body for status code(s): 200, 201
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "scanResults": [
           {
               "assetsClassified": 0.0,  # Optional.
               "assetsDiscovered": 0.0,  # Optional.
               "dataSourceType": "str",  # Optional. Possible values include: "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".
               "diagnostics": {
                   "exceptionCountMap": {
                       "str": 0  # Optional. Dictionary of :code:`<integer>`.
                   },
                   "notifications": [
                       {
                           "code": 0,  # Optional.
                           "message": "str"  # Optional.
                       }
                   ]
               },
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "error": {
                   "code": "str",  # Optional.
                   "details": [
                       {
                           "code": "str",  # Optional.
                           "details": [
                               ...
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       }
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               },
               "errorMessage": "str",  # Optional.
               "id": "str",  # Optional.
               "parentId": "str",  # Optional.
               "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
               "queuedTime": "2020-02-20 00:00:00",  # Optional.
               "resourceId": "str",  # Optional.
               "runType": "str",  # Optional.
               "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "scanRulesetVersion": 0,  # Optional.
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "status": "str"  # Optional.
           }
       ],
       kind: Scan
   }

delete

Deletes the scan associated with the data source.

delete(data_source_name: str, scan_name: str, **kwargs: Any) -> Optional[Any]

Parameters

data_source_name

str

Required

scan_name

str

Required

Returns

JSON object

Return type

<xref:Any>,

None

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "scanResults": [
           {
               "assetsClassified": 0.0,  # Optional.
               "assetsDiscovered": 0.0,  # Optional.
               "dataSourceType": "str",  # Optional. Possible values include: "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".
               "diagnostics": {
                   "exceptionCountMap": {
                       "str": 0  # Optional. Dictionary of :code:`<integer>`.
                   },
                   "notifications": [
                       {
                           "code": 0,  # Optional.
                           "message": "str"  # Optional.
                       }
                   ]
               },
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "error": {
                   "code": "str",  # Optional.
                   "details": [
                       {
                           "code": "str",  # Optional.
                           "details": [
                               ...
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       }
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               },
               "errorMessage": "str",  # Optional.
               "id": "str",  # Optional.
               "parentId": "str",  # Optional.
               "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
               "queuedTime": "2020-02-20 00:00:00",  # Optional.
               "resourceId": "str",  # Optional.
               "runType": "str",  # Optional.
               "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "scanRulesetVersion": 0,  # Optional.
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "status": "str"  # Optional.
           }
       ],
       kind: Scan
   }

get

Gets a scan information.

get(data_source_name: str, scan_name: str, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "id": "str",  # Optional.
       "name": "str",  # Optional.
       "scanResults": [
           {
               "assetsClassified": 0.0,  # Optional.
               "assetsDiscovered": 0.0,  # Optional.
               "dataSourceType": "str",  # Optional. Possible values include: "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".
               "diagnostics": {
                   "exceptionCountMap": {
                       "str": 0  # Optional. Dictionary of :code:`<integer>`.
                   },
                   "notifications": [
                       {
                           "code": 0,  # Optional.
                           "message": "str"  # Optional.
                       }
                   ]
               },
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "error": {
                   "code": "str",  # Optional.
                   "details": [
                       {
                           "code": "str",  # Optional.
                           "details": [
                               ...
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       }
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               },
               "errorMessage": "str",  # Optional.
               "id": "str",  # Optional.
               "parentId": "str",  # Optional.
               "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
               "queuedTime": "2020-02-20 00:00:00",  # Optional.
               "resourceId": "str",  # Optional.
               "runType": "str",  # Optional.
               "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "scanRulesetVersion": 0,  # Optional.
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "status": "str"  # Optional.
           }
       ],
       kind: Scan
   }

list_by_data_source

List scans in data source.

list_by_data_source(data_source_name: str, **kwargs: Any) -> Iterable[Any]

Parameters

data_source_name

str

Required

Returns

An iterator like instance of JSON object

Return type

ItemPaged[<xref:Any>]

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "count": 0.0,  # Optional.
       "nextLink": "str",  # Optional.
       "value": [
           {
               "id": "str",  # Optional.
               "name": "str",  # Optional.
               "scanResults": [
                   {
                       "assetsClassified": 0.0,  # Optional.
                       "assetsDiscovered": 0.0,  # Optional.
                       "dataSourceType": "str",  # Optional. Possible values include: "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".
                       "diagnostics": {
                           "exceptionCountMap": {
                               "str": 0  # Optional. Dictionary of :code:`<integer>`.
                           },
                           "notifications": [
                               {
                                   "code": 0,  # Optional.
                                   "message": "str"  # Optional.
                               }
                           ]
                       },
                       "endTime": "2020-02-20 00:00:00",  # Optional.
                       "error": {
                           "code": "str",  # Optional.
                           "details": [
                               {
                                   "code": "str",  # Optional.
                                   "details": [
                                       ...
                                   ],
                                   "message": "str",  # Optional.
                                   "target": "str"  # Optional.
                               }
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       },
                       "errorMessage": "str",  # Optional.
                       "id": "str",  # Optional.
                       "parentId": "str",  # Optional.
                       "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
                       "queuedTime": "2020-02-20 00:00:00",  # Optional.
                       "resourceId": "str",  # Optional.
                       "runType": "str",  # Optional.
                       "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
                       "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
                       "scanRulesetVersion": 0,  # Optional.
                       "startTime": "2020-02-20 00:00:00",  # Optional.
                       "status": "str"  # Optional.
                   }
               ],
               kind: Scan
           }
       ]
   }