Share via

ScanRulesetsOperations Class

  • Reference

ScanRulesetsOperations 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
ScanRulesetsOperations

Constructor

ScanRulesetsOperations(client, config, serializer, deserializer)

Parameters

Name Description
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 or Updates a scan ruleset.
delete

Deletes a scan ruleset.
get

Get a scan ruleset.
list_all

List scan rulesets in Data catalog.

create_or_update

Creates or Updates a scan ruleset.

create_or_update(scan_ruleset_name: str, body: Any = None, **kwargs: Any) -> Any

Parameters

Name Description
scan_ruleset_name
Required
str
body
Required
Any

Returns

Type Description
Any

JSON object

Exceptions

Type Description
HttpResponseError

Examples


   kind = 'AdlsGen1ScanRuleset' or 'AdlsGen2ScanRuleset' or 'AmazonAccountScanRuleset' or 'AmazonPostgreSqlScanRuleset' or 'AmazonS3ScanRuleset' or 'AmazonSqlScanRuleset' or 'AzureCosmosDbScanRuleset' or 'AzureDataExplorerScanRuleset' or 'AzureFileServiceScanRuleset' or 'AzureMySqlScanRuleset' or 'AzurePostgreSqlScanRuleset' or 'AzureResourceGroupScanRuleset' or 'AzureSqlDataWarehouseScanRuleset' or 'AzureSqlDatabaseScanRuleset' or 'AzureSqlDatabaseManagedInstanceScanRuleset' or 'AzureStorageScanRuleset' or 'AzureSubscriptionScanRuleset' or 'AzureSynapseScanRuleset' or 'AzureSynapseWorkspaceScanRuleset' or 'OracleScanRuleset' or 'PowerBIScanRuleset' or 'SapEccScanRuleset' or 'SapS4HanaScanRuleset' or 'SqlServerDatabaseScanRuleset' or 'TeradataScanRuleset'

   # JSON input template you can fill out and use as your body input.
   body = {
       "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: ScanRuleset
   }

   # response body for status code(s): 200, 201
   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: ScanRuleset
   }

delete

Deletes a scan ruleset.

delete(scan_ruleset_name: str, **kwargs: Any) -> Any | None

Parameters

Name Description
scan_ruleset_name
Required
str

Returns

Type Description
Any,
None

JSON object

Exceptions

Type Description
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: ScanRuleset
   }

get

Get a scan ruleset.

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

Parameters

Name Description
scan_ruleset_name
Required
str

Returns

Type Description
Any

JSON object

Exceptions

Type Description
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: ScanRuleset
   }

list_all

List scan rulesets in Data catalog.

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

Returns

Type Description
ItemPaged[Any]

An iterator like instance of JSON object

Exceptions

Type Description
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: ScanRuleset
           }
       ]
   }