Scan Rulesets - Get

Service:: Purview

API Version:: 2023-09-01

Gets a scan ruleset.

GET {endpoint}/scan/scanrulesets/{scanRulesetName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (url)	The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.
scanRulesetName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The scan ruleset name.
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	ScanRuleset: AzureSubscriptionScanRuleset AzureResourceGroupScanRuleset AzureSynapseWorkspaceScanRuleset AzureSynapseScanRuleset AdlsGen1ScanRuleset AdlsGen2ScanRuleset AmazonAccountScanRuleset AmazonS3ScanRuleset AmazonSqlScanRuleset AzureCosmosDbScanRuleset AzureDataExplorerScanRuleset AzureFileServiceScanRuleset AzureSqlDatabaseScanRuleset AmazonPostgreSqlScanRuleset AzurePostgreSqlScanRuleset SqlServerDatabaseScanRuleset AzureSqlDatabaseManagedInstanceScanRuleset AzureSqlDataWarehouseScanRuleset AzureMySqlScanRuleset AzureStorageScanRuleset TeradataScanRuleset OracleScanRuleset SapS4HanaScanRuleset SapEccScanRuleset PowerBIScanRuleset	Success.
Other Status Codes	ErrorResponseModel	An error response received from the Scanning Service. Headers x-ms-error-code: string

Name

Type

Description

200 OK

ScanRuleset:

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

Success.

Other Status Codes

ErrorResponseModel

An error response received from the Scanning Service.

Headers

x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ScanRulesets_Get

Sample request

HTTP

GET {endpoint}/scan/scanrulesets/nyScanRulesetName?api-version=2023-09-01

Sample response

Status code:: 200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "properties": {
    "scanningRule": {
      "fileExtensions": [
        "CSV",
        "JSON"
      ]
    },
    "createdAt": "2020-01-28T23:09:30.5185162Z",
    "lastModifiedAt": "2020-01-28T23:10:07.3840172Z",
    "excludedSystemClassifications": null,
    "includedCustomClassificationRuleNames": null,
    "description": null
  },
  "kind": "AzureStorage",
  "name": "myRuleSetName"
}

Definitions

Name	Description
AdlsGen1ScanRuleset	ADLS Gen1 scan ruleset.
AdlsGen1ScanRulesetProperties	ADLS Gen1 scan ruleset properties.
AdlsGen2ScanRuleset	Adls gen 2 scan ruleset.
AdlsGen2ScanRulesetProperties	Adls gen 2 scan ruleset properties.
AmazonAccountScanRuleset	Amazon account scan ruleset.
AmazonAccountScanRulesetProperties	Amazon account scan ruleset properties.
AmazonPostgreSqlScanRuleset	Azure Postgre SQL scan ruleset.
AmazonPostgreSqlScanRulesetProperties	Azure Postgre SQL scan ruleset properties.
AmazonS3ScanRuleset	Amazon S3 scan ruleset.
AmazonS3ScanRulesetProperties	Amazon S3 scan ruleset properties.
AmazonSqlScanRuleset	Amazon SQL scan ruleset.
AmazonSqlScanRulesetProperties	Amazon SQL scan ruleset properties.
AzureCosmosDbScanRuleset	Azure Cosmos DB scan ruleset.
AzureCosmosDbScanRulesetProperties	Azure Cosmos DB scan ruleset properties.
AzureDataExplorerScanRuleset	Azure data explorer scan ruleset.
AzureDataExplorerScanRulesetProperties	Azure data explorer scan ruleset properties.
AzureFileServiceScanRuleset	Azure file service scan ruleset.
AzureFileServiceScanRulesetProperties	Azure file service scan ruleset properties.
AzureMySqlScanRuleset	Azure MySQL scan ruleset.
AzureMySqlScanRulesetProperties	Azure MySQL scan ruleset properties.
AzurePostgreSqlScanRuleset	Azure Postgre SQL scan ruleset.
AzurePostgreSqlScanRulesetProperties	Azure Postgre SQL scan ruleset properties.
AzureResourceGroupScanRuleset	Azure resource group scan ruleset.
AzureResourceGroupScanRulesetProperties	Azure resource group scan ruleset properties.
AzureSqlDatabaseManagedInstanceScanRuleset	Azure SQL db managed instance scan ruleset.
AzureSqlDatabaseManagedInstanceScanRulesetProperties	Azure SQL db managed instance scan ruleset properties.
AzureSqlDatabaseScanRuleset	Azure SQL db scan ruleset.
AzureSqlDatabaseScanRulesetProperties	Azure SQL db scan ruleset properties.
AzureSqlDataWarehouseScanRuleset	Azure SQL data warehouse scan ruleset.
AzureSqlDataWarehouseScanRulesetProperties	Azure SQL data warehouse scan ruleset properties.
AzureStorageScanRuleset	Azure Storage scan ruleset.
AzureStorageScanRulesetProperties	Azure Storage scan ruleset properties.
AzureSubscriptionScanRuleset	Azure subscription scan ruleset.
AzureSubscriptionScanRulesetProperties	Azure subscription scan ruleset properties.
AzureSynapseScanRuleset	Azure synapse scan ruleset.
AzureSynapseScanRulesetProperties	Azure synapse scan ruleset properties.
AzureSynapseWorkspaceScanRuleset	Azure synapse workspace scan ruleset.
AzureSynapseWorkspaceScanRulesetProperties	Azure synapse workspace scan ruleset properties.
CustomFileExtension	Custom file extension.
CustomFileType	Custom file type.
DataSourceType	The data source type.
ErrorModel	The error model.
ErrorResponseModel	The error response model.
FileExtensionsType	The built-in file type of the custom file type.
OracleScanRuleset	Oracle scan ruleset.
OracleScanRulesetProperties	Oracle scan rule set properties.
PowerBIScanRuleset	Power BI scan ruleset.
PowerBIScanRulesetProperties	Power BI scan ruleset properties.
SapEccScanRuleset	SAP ECC scan ruleset.
SapEccScanRulesetProperties	SAP ECC scan ruleset properties.
SapS4HanaScanRuleset	SAP S/4HANA scan ruleset.
SapS4HanaScanRulesetProperties	SAP S/4HANA scan ruleset properties.
ScanningRule	Scanning rule.
ScanRulesetStatus	Status of versioned scan ruleset properties.
ScanRulesetType	The scan ruleset type.
SqlServerDatabaseScanRuleset	Sql server database scan ruleset.
SqlServerDatabaseScanRulesetProperties	Sql server database scan ruleset properties.
TeradataScanRuleset	Teradata scan ruleset.
TeradataScanRulesetProperties	Teradata scan ruleset properties.

AdlsGen1ScanRuleset

Object

ADLS Gen1 scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AdlsGen1	The data source type.
name	string	The resource name.
properties	AdlsGen1ScanRulesetProperties	ADLS Gen1 scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AdlsGen1ScanRulesetProperties

Object

ADLS Gen1 scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

AdlsGen2ScanRuleset

Object

Adls gen 2 scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AdlsGen2	The data source type.
name	string	The resource name.
properties	AdlsGen2ScanRulesetProperties	Adls gen 2 scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AdlsGen2ScanRulesetProperties

Object

Adls gen 2 scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

AmazonAccountScanRuleset

Object

Amazon account scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AmazonAccount	The data source type.
name	string	The resource name.
properties	AmazonAccountScanRulesetProperties	Amazon account scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AmazonAccountScanRulesetProperties

Object

Amazon account scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AmazonPostgreSqlScanRuleset

Object

Azure Postgre SQL scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AmazonPostgreSql	The data source type.
name	string	The resource name.
properties	AmazonPostgreSqlScanRulesetProperties	Azure Postgre SQL scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AmazonPostgreSqlScanRulesetProperties

Object

Azure Postgre SQL scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AmazonS3ScanRuleset

Object

Amazon S3 scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AmazonS3	The data source type.
name	string	The resource name.
properties	AmazonS3ScanRulesetProperties	Amazon S3 scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AmazonS3ScanRulesetProperties

Object

Amazon S3 scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

AmazonSqlScanRuleset

Object

Amazon SQL scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AmazonSql	The data source type.
name	string	The resource name.
properties	AmazonSqlScanRulesetProperties	Amazon SQL scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AmazonSqlScanRulesetProperties

Object

Amazon SQL scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureCosmosDbScanRuleset

Object

Azure Cosmos DB scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureCosmosDb	The data source type.
name	string	The resource name.
properties	AzureCosmosDbScanRulesetProperties	Azure Cosmos DB scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureCosmosDbScanRulesetProperties

Object

Azure Cosmos DB scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureDataExplorerScanRuleset

Object

Azure data explorer scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureDataExplorer	The data source type.
name	string	The resource name.
properties	AzureDataExplorerScanRulesetProperties	Azure data explorer scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureDataExplorerScanRulesetProperties

Object

Azure data explorer scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureFileServiceScanRuleset

Object

Azure file service scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureFileService	The data source type.
name	string	The resource name.
properties	AzureFileServiceScanRulesetProperties	Azure file service scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureFileServiceScanRulesetProperties

Object

Azure file service scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

AzureMySqlScanRuleset

Object

Azure MySQL scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureMySql	The data source type.
name	string	The resource name.
properties	AzureMySqlScanRulesetProperties	Azure MySQL scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureMySqlScanRulesetProperties

Object

Azure MySQL scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzurePostgreSqlScanRuleset

Object

Azure Postgre SQL scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzurePostgreSql	The data source type.
name	string	The resource name.
properties	AzurePostgreSqlScanRulesetProperties	Azure Postgre SQL scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzurePostgreSqlScanRulesetProperties

Object

Azure Postgre SQL scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureResourceGroupScanRuleset

Object

Azure resource group scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureResourceGroup	The data source type.
name	string	The resource name.
properties	AzureResourceGroupScanRulesetProperties	Azure resource group scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureResourceGroupScanRulesetProperties

Object

Azure resource group scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureSqlDatabaseManagedInstanceScanRuleset

Object

Azure SQL db managed instance scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSqlDatabaseManagedInstance	The data source type.
name	string	The resource name.
properties	AzureSqlDatabaseManagedInstanceScanRulesetProperties	Azure SQL db managed instance scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSqlDatabaseManagedInstanceScanRulesetProperties

Object

Azure SQL db managed instance scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureSqlDatabaseScanRuleset

Object

Azure SQL db scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSqlDatabase	The data source type.
name	string	The resource name.
properties	AzureSqlDatabaseScanRulesetProperties	Azure SQL db scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSqlDatabaseScanRulesetProperties

Object

Azure SQL db scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureSqlDataWarehouseScanRuleset

Object

Azure SQL data warehouse scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSqlDataWarehouse	The data source type.
name	string	The resource name.
properties	AzureSqlDataWarehouseScanRulesetProperties	Azure SQL data warehouse scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSqlDataWarehouseScanRulesetProperties

Object

Azure SQL data warehouse scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureStorageScanRuleset

Object

Azure Storage scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureStorage	The data source type.
name	string	The resource name.
properties	AzureStorageScanRulesetProperties	Azure Storage scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureStorageScanRulesetProperties

Object

Azure Storage scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

AzureSubscriptionScanRuleset

Object

Azure subscription scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSubscription	The data source type.
name	string	The resource name.
properties	AzureSubscriptionScanRulesetProperties	Azure subscription scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSubscriptionScanRulesetProperties

Object

Azure subscription scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureSynapseScanRuleset

Object

Azure synapse scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSynapse	The data source type.
name	string	The resource name.
properties	AzureSynapseScanRulesetProperties	Azure synapse scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSynapseScanRulesetProperties

Object

Azure synapse scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

AzureSynapseWorkspaceScanRuleset

Object

Azure synapse workspace scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: AzureSynapseWorkspace	The data source type.
name	string	The resource name.
properties	AzureSynapseWorkspaceScanRulesetProperties	Azure synapse workspace scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

AzureSynapseWorkspaceScanRulesetProperties

Object

Azure synapse workspace scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

CustomFileExtension

Object

Custom file extension.

Name	Type	Description
customFileType	CustomFileType	The custom file type of the custom file extension.
description	string	The description of the custom file extension.
enabled	boolean	The flag to indicate whether the custom file extension is enabled or not.
fileExtension	string	The file extension of the custom file extension.

CustomFileType

Object

Custom file type.

Name	Type	Description
builtInType	FileExtensionsType	The built-in file type of the custom file type.
customDelimiter	string	The custom delimiter of the custom file type.

DataSourceType

Enumeration

The data source type.

Value	Description
None
Fabric
AzureSubscription
AzureResourceGroup
AzureSynapseWorkspace
AzureSynapse
AdlsGen1
AdlsGen2
AmazonAccount
AmazonS3
AmazonSql
AzureCosmosDb
AzureDataExplorer
AzureFileService
AzureSqlDatabase
ArcEnabledSqlServer
AmazonPostgreSql
AzurePostgreSql
Databricks
SqlServerDatabase
AzureSqlDatabaseManagedInstance
AzureSqlDataWarehouse
AzureMySql
Hdfs
TableauServer
AzureStorage
Teradata
Oracle
PostgreSql
AmazonRedShift
DatabricksHms
SapS4Hana
SapEcc
Snowflake
PowerBI
Trident
Dataverse
DatabricksUnityCatalog

ErrorModel

Object

The error model.

Name	Type	Description
code	string	A unique error code that identifies the specific error.
details	ErrorModel[]	An array of nested ErrorModel objects that provides additional error details.
message	string	A human-readable error message that provides more details about the error.
target	string	The specific component that the error is associated with.

ErrorResponseModel

Object

The error response model.

Name	Type	Description
error	ErrorModel	The error model.

FileExtensionsType

Enumeration

The built-in file type of the custom file type.

Value	Description
AVRO
ORC
PARQUET
JSON
TXT
XML
Documents
CSV
PSV
SSV
TSV
GZ
DOC
DOCM
DOCX
DOT
ODP
ODS
ODT
PDF
POT
PPS
PPSX
PPT
PPTM
PPTX
XLC
XLS
XLSB
XLSM
XLSX
XLT

OracleScanRuleset

Object

Oracle scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: Oracle	The data source type.
name	string	The resource name.
properties	OracleScanRulesetProperties	Oracle scan rule set properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

OracleScanRulesetProperties

Object

Oracle scan rule set properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

PowerBIScanRuleset

Object

Power BI scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: PowerBI	The data source type.
name	string	The resource name.
properties	PowerBIScanRulesetProperties	Power BI scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

PowerBIScanRulesetProperties

Object

Power BI scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

SapEccScanRuleset

Object

SAP ECC scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: SapEcc	The data source type.
name	string	The resource name.
properties	SapEccScanRulesetProperties	SAP ECC scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

SapEccScanRulesetProperties

Object

SAP ECC scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

SapS4HanaScanRuleset

Object

SAP S/4HANA scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: SapS4Hana	The data source type.
name	string	The resource name.
properties	SapS4HanaScanRulesetProperties	SAP S/4HANA scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

SapS4HanaScanRulesetProperties

Object

SAP S/4HANA scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

ScanningRule

Object

Scanning rule.

Name	Type	Description
customFileExtensions	CustomFileExtension[]	The custom file extensions of the scanning rule.
fileExtensions	FileExtensionsType[]	The file extensions of the scanning rule.

ScanRulesetStatus

Enumeration

Status of versioned scan ruleset properties.

Value	Description
Enabled
Disabled

ScanRulesetType

Enumeration

The scan ruleset type.

Value	Description
Custom	the scan ruleset type is custom
System	the scan ruleset type is system default

SqlServerDatabaseScanRuleset

Object

Sql server database scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: SqlServerDatabase	The data source type.
name	string	The resource name.
properties	SqlServerDatabaseScanRulesetProperties	Sql server database scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

SqlServerDatabaseScanRulesetProperties

Object

Sql server database scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.

TeradataScanRuleset

Object

Teradata scan ruleset.

Name	Type	Description
id	string	The resource identifier.
kind	string: Teradata	The data source type.
name	string	The resource name.
properties	TeradataScanRulesetProperties	Teradata scan ruleset properties.
scanRulesetType	ScanRulesetType	Versioned scan ruleset properties.
status	ScanRulesetStatus	Status of versioned scan ruleset properties.
version	integer (int32)	Version of versioned scan ruleset properties.

TeradataScanRulesetProperties

Object

Teradata scan ruleset properties.

Name	Type	Description
createdAt	string (date-time)	The time at which the scan ruleset was created.
description	string
excludedSystemClassifications	string[]	The system classifications that are excluded from the scan ruleset.
includedCustomClassificationRuleNames	string[]	The custom classification rule names that are included in the scan ruleset.
lastModifiedAt	string (date-time)	The time at which the scan ruleset was last modified.
scanningRule	ScanningRule	The scanning rule of the scanning rule scan ruleset.

Share via

Scan Rulesets - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ScanRulesets_Get

Sample request

Sample response

Definitions

AdlsGen1ScanRuleset

AdlsGen1ScanRulesetProperties

AdlsGen2ScanRuleset

AdlsGen2ScanRulesetProperties

AmazonAccountScanRuleset

AmazonAccountScanRulesetProperties

AmazonPostgreSqlScanRuleset

AmazonPostgreSqlScanRulesetProperties

AmazonS3ScanRuleset

AmazonS3ScanRulesetProperties

AmazonSqlScanRuleset

AmazonSqlScanRulesetProperties

AzureCosmosDbScanRuleset

AzureCosmosDbScanRulesetProperties

AzureDataExplorerScanRuleset

AzureDataExplorerScanRulesetProperties

AzureFileServiceScanRuleset

AzureFileServiceScanRulesetProperties

AzureMySqlScanRuleset

AzureMySqlScanRulesetProperties

AzurePostgreSqlScanRuleset

AzurePostgreSqlScanRulesetProperties

AzureResourceGroupScanRuleset

AzureResourceGroupScanRulesetProperties

AzureSqlDatabaseManagedInstanceScanRuleset

AzureSqlDatabaseManagedInstanceScanRulesetProperties

AzureSqlDatabaseScanRuleset

AzureSqlDatabaseScanRulesetProperties

AzureSqlDataWarehouseScanRuleset

AzureSqlDataWarehouseScanRulesetProperties

AzureStorageScanRuleset

AzureStorageScanRulesetProperties

AzureSubscriptionScanRuleset

AzureSubscriptionScanRulesetProperties

AzureSynapseScanRuleset

AzureSynapseScanRulesetProperties

AzureSynapseWorkspaceScanRuleset

AzureSynapseWorkspaceScanRulesetProperties

CustomFileExtension

CustomFileType

DataSourceType

ErrorModel

ErrorResponseModel

FileExtensionsType

OracleScanRuleset

OracleScanRulesetProperties

PowerBIScanRuleset

PowerBIScanRulesetProperties

SapEccScanRuleset

SapEccScanRulesetProperties

SapS4HanaScanRuleset

SapS4HanaScanRulesetProperties

ScanningRule

ScanRulesetStatus

ScanRulesetType

SqlServerDatabaseScanRuleset

SqlServerDatabaseScanRulesetProperties

TeradataScanRuleset

TeradataScanRulesetProperties