SystemScanRulesetsOperations Class

SystemScanRulesetsOperations 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

SystemScanRulesetsOperations

Constructor

SystemScanRulesetsOperations(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

get	Get a system scan ruleset for a data source.
get_by_version	Get a scan ruleset by version.
get_latest	Get the latest version of a system scan ruleset.
list_all	List all system scan rulesets for an account.
list_versions_by_data_source	List system scan ruleset versions in Data catalog.

get

Get a system scan ruleset for a data source.

get(data_source_type: str, **kwargs: Any) -> Any

Parameters

data_source_type

str

Required

Possible values are: "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", and "PowerBI".

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.
       "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
       "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
       "version": 0,  # Optional.
       kind: SystemScanRuleset
   }

get_by_version

Get a scan ruleset by version.

get_by_version(version: int, **kwargs: Any) -> Any

Parameters

version

int

Required

data_source_type

str

Possible values are: "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", and "PowerBI".

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.
       "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
       "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
       "version": 0,  # Optional.
       kind: SystemScanRuleset
   }

get_latest

Get the latest version of a system scan ruleset.

get_latest(**kwargs: Any) -> Any

Parameters

data_source_type

str

Possible values are: "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", and "PowerBI".

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.
       "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
       "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
       "version": 0,  # Optional.
       kind: SystemScanRuleset
   }

list_all

List all system scan rulesets for an account.

list_all(**kwargs: Any) -> Iterable[Any]

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.
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
               "version": 0,  # Optional.
               kind: SystemScanRuleset
           }
       ]
   }

list_versions_by_data_source

List system scan ruleset versions in Data catalog.

list_versions_by_data_source(**kwargs: Any) -> Iterable[Any]

Parameters

data_source_type

str

Possible values are: "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", and "PowerBI".

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.
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
               "version": 0,  # Optional.
               kind: SystemScanRuleset
           }
       ]
   }