你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Scan Rulesets - Get

参考

服务:: Purview

API 版本:: 2023-09-01

获取扫描规则集。

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

URI 参数

名称在必需类型说明

名称	在	必需	类型	说明
endpoint	path	True	string url	purview 帐户的扫描终结点。示例：https://{accountName}.purview.azure.com。
scanRulesetName	path	True	string	扫描规则集名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
api-version	query	True	string	要使用的 API 版本。

endpoint

path

True

string

url

purview 帐户的扫描终结点。示例：https://{accountName}.purview.azure.com。

scanRulesetName

path

True

string

扫描规则集名称。

正则表达式模式: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

api-version

query

True

string

要使用的 API 版本。

响应

名称	类型	说明
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	成功。
Other Status Codes	ErrorResponseModel	从扫描服务收到的错误响应。标头 x-ms-error-code: string

名称

类型

说明

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

成功。

Other Status Codes

ErrorResponseModel

从扫描服务收到的错误响应。

标头

x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ScanRulesets_Get

示例请求

HTTP

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

示例响应

状态代码:: 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"
}

定义

名称	说明
AdlsGen1ScanRuleset	ADLS Gen1 扫描规则集。
AdlsGen1ScanRulesetProperties	ADLS Gen1 扫描规则集属性。
AdlsGen2ScanRuleset	Adls gen 2 扫描规则集。
AdlsGen2ScanRulesetProperties	Adls gen 2 扫描规则集属性。
AmazonAccountScanRuleset	Amazon 帐户扫描规则集。
AmazonAccountScanRulesetProperties	Amazon 帐户扫描规则集属性。
AmazonPostgreSqlScanRuleset	Azure Postgre SQL 扫描规则集。
AmazonPostgreSqlScanRulesetProperties	Azure Postgre SQL 扫描规则集属性。
AmazonS3ScanRuleset	Amazon S3 扫描规则集。
AmazonS3ScanRulesetProperties	Amazon S3 扫描规则集属性。
AmazonSqlScanRuleset	Amazon SQL 扫描规则集。
AmazonSqlScanRulesetProperties	Amazon SQL 扫描规则集属性。
AzureCosmosDbScanRuleset	Azure Cosmos DB 扫描规则集。
AzureCosmosDbScanRulesetProperties	Azure Cosmos DB 扫描规则集属性。
AzureDataExplorerScanRuleset	Azure 数据资源管理器扫描规则集。
AzureDataExplorerScanRulesetProperties	Azure 数据资源管理器扫描规则集属性。
AzureFileServiceScanRuleset	Azure 文件服务扫描规则集。
AzureFileServiceScanRulesetProperties	Azure 文件服务扫描规则集属性。
AzureMySqlScanRuleset	Azure MySQL 扫描规则集。
AzureMySqlScanRulesetProperties	Azure MySQL 扫描规则集属性。
AzurePostgreSqlScanRuleset	Azure Postgre SQL 扫描规则集。
AzurePostgreSqlScanRulesetProperties	Azure Postgre SQL 扫描规则集属性。
AzureResourceGroupScanRuleset	Azure 资源组扫描规则集。
AzureResourceGroupScanRulesetProperties	Azure 资源组扫描规则集属性。
AzureSqlDatabaseManagedInstanceScanRuleset	Azure SQL db 托管实例扫描规则集。
AzureSqlDatabaseManagedInstanceScanRulesetProperties	Azure SQL数据库托管实例扫描规则集属性。
AzureSqlDatabaseScanRuleset	Azure SQL数据库扫描规则集。
AzureSqlDatabaseScanRulesetProperties	Azure SQL数据库扫描规则集属性。
AzureSqlDataWarehouseScanRuleset	Azure SQL数据仓库扫描规则集。
AzureSqlDataWarehouseScanRulesetProperties	Azure SQL数据仓库扫描规则集属性。
AzureStorageScanRuleset	Azure 存储扫描规则集。
AzureStorageScanRulesetProperties	Azure 存储扫描规则集属性。
AzureSubscriptionScanRuleset	Azure 订阅扫描规则集。
AzureSubscriptionScanRulesetProperties	Azure 订阅扫描规则集属性。
AzureSynapseScanRuleset	Azure synapse 扫描规则集。
AzureSynapseScanRulesetProperties	Azure synapse 扫描规则集属性。
AzureSynapseWorkspaceScanRuleset	Azure synapse 工作区扫描规则集。
AzureSynapseWorkspaceScanRulesetProperties	Azure synapse 工作区扫描规则集属性。
CustomFileExtension	自定义文件扩展名。
CustomFileType	自定义文件类型。
DataSourceType	数据源类型。
ErrorModel	错误模型。
ErrorResponseModel	错误响应模型。
FileExtensionsType	自定义文件类型的内置文件类型。
OracleScanRuleset	Oracle 扫描规则集。
OracleScanRulesetProperties	Oracle 扫描规则集属性。
PowerBIScanRuleset	Power BI 扫描规则集。
PowerBIScanRulesetProperties	Power BI 扫描规则集属性。
SapEccScanRuleset	SAP ECC 扫描规则集。
SapEccScanRulesetProperties	SAP ECC 扫描规则集属性。
SapS4HanaScanRuleset	SAP S/4HANA 扫描规则集。
SapS4HanaScanRulesetProperties	SAP S/4HANA 扫描规则集属性。
ScanningRule	扫描规则。
ScanRulesetStatus	版本控制扫描规则集属性的状态。
ScanRulesetType	扫描规则集类型。
SqlServerDatabaseScanRuleset	Sql Server 数据库扫描规则集。
SqlServerDatabaseScanRulesetProperties	Sql Server 数据库扫描规则集属性。
TeradataScanRuleset	Teradata 扫描规则集。
TeradataScanRulesetProperties	Teradata 扫描规则集属性。

AdlsGen1ScanRuleset

ADLS Gen1 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AdlsGen1	数据源类型。
name	string	资源名称。
properties	AdlsGen1ScanRulesetProperties	ADLS Gen1 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AdlsGen1ScanRulesetProperties

ADLS Gen1 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

AdlsGen2ScanRuleset

Adls gen 2 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AdlsGen2	数据源类型。
name	string	资源名称。
properties	AdlsGen2ScanRulesetProperties	Adls gen 2 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AdlsGen2ScanRulesetProperties

Adls gen 2 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

AmazonAccountScanRuleset

Amazon 帐户扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AmazonAccount	数据源类型。
name	string	资源名称。
properties	AmazonAccountScanRulesetProperties	Amazon 帐户扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AmazonAccountScanRulesetProperties

Amazon 帐户扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AmazonPostgreSqlScanRuleset

Azure Postgre SQL 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AmazonPostgreSql	数据源类型。
name	string	资源名称。
properties	AmazonPostgreSqlScanRulesetProperties	Azure Postgre SQL 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AmazonPostgreSqlScanRulesetProperties

Azure Postgre SQL 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AmazonS3ScanRuleset

Amazon S3 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AmazonS3	数据源类型。
name	string	资源名称。
properties	AmazonS3ScanRulesetProperties	Amazon S3 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AmazonS3ScanRulesetProperties

Amazon S3 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

AmazonSqlScanRuleset

Amazon SQL 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AmazonSql	数据源类型。
name	string	资源名称。
properties	AmazonSqlScanRulesetProperties	Amazon SQL 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AmazonSqlScanRulesetProperties

Amazon SQL 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureCosmosDbScanRuleset

Azure Cosmos DB 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureCosmosDb	数据源类型。
name	string	资源名称。
properties	AzureCosmosDbScanRulesetProperties	Azure Cosmos DB 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureCosmosDbScanRulesetProperties

Azure Cosmos DB 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureDataExplorerScanRuleset

Azure 数据资源管理器扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureDataExplorer	数据源类型。
name	string	资源名称。
properties	AzureDataExplorerScanRulesetProperties	Azure 数据资源管理器扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureDataExplorerScanRulesetProperties

Azure 数据资源管理器扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureFileServiceScanRuleset

Azure 文件服务扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureFileService	数据源类型。
name	string	资源名称。
properties	AzureFileServiceScanRulesetProperties	Azure 文件服务扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureFileServiceScanRulesetProperties

Azure 文件服务扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

AzureMySqlScanRuleset

Azure MySQL 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureMySql	数据源类型。
name	string	资源名称。
properties	AzureMySqlScanRulesetProperties	Azure MySQL 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureMySqlScanRulesetProperties

Azure MySQL 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzurePostgreSqlScanRuleset

Azure Postgre SQL 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzurePostgreSql	数据源类型。
name	string	资源名称。
properties	AzurePostgreSqlScanRulesetProperties	Azure Postgre SQL 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzurePostgreSqlScanRulesetProperties

Azure Postgre SQL 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureResourceGroupScanRuleset

Azure 资源组扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureResourceGroup	数据源类型。
name	string	资源名称。
properties	AzureResourceGroupScanRulesetProperties	Azure 资源组扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureResourceGroupScanRulesetProperties

Azure 资源组扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureSqlDatabaseManagedInstanceScanRuleset

Azure SQL db 托管实例扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSqlDatabaseManagedInstance	数据源类型。
name	string	资源名称。
properties	AzureSqlDatabaseManagedInstanceScanRulesetProperties	Azure SQL db 托管实例扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSqlDatabaseManagedInstanceScanRulesetProperties

Azure SQL数据库托管实例扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureSqlDatabaseScanRuleset

Azure SQL数据库扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSqlDatabase	数据源类型。
name	string	资源名称。
properties	AzureSqlDatabaseScanRulesetProperties	Azure SQL db 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSqlDatabaseScanRulesetProperties

Azure SQL数据库扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureSqlDataWarehouseScanRuleset

Azure SQL数据仓库扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSqlDataWarehouse	数据源类型。
name	string	资源名称。
properties	AzureSqlDataWarehouseScanRulesetProperties	Azure SQL数据仓库扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSqlDataWarehouseScanRulesetProperties

Azure SQL数据仓库扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureStorageScanRuleset

Azure 存储扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureStorage	数据源类型。
name	string	资源名称。
properties	AzureStorageScanRulesetProperties	Azure 存储扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureStorageScanRulesetProperties

Azure 存储扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

AzureSubscriptionScanRuleset

Azure 订阅扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSubscription	数据源类型。
name	string	资源名称。
properties	AzureSubscriptionScanRulesetProperties	Azure 订阅扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSubscriptionScanRulesetProperties

Azure 订阅扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureSynapseScanRuleset

Azure synapse 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSynapse	数据源类型。
name	string	资源名称。
properties	AzureSynapseScanRulesetProperties	Azure synapse 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSynapseScanRulesetProperties

Azure synapse 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

AzureSynapseWorkspaceScanRuleset

Azure synapse 工作区扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: AzureSynapseWorkspace	数据源类型。
name	string	资源名称。
properties	AzureSynapseWorkspaceScanRulesetProperties	Azure synapse 工作区扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

AzureSynapseWorkspaceScanRulesetProperties

Azure synapse 工作区扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

CustomFileExtension

自定义文件扩展名。

名称	类型	说明
customFileType	CustomFileType	自定义文件扩展名的自定义文件类型。
description	string	自定义文件扩展名的说明。
enabled	boolean	指示是否启用自定义文件扩展名的标志。
fileExtension	string	自定义文件扩展名的文件扩展名。

CustomFileType

自定义文件类型。

名称	类型	说明
builtInType	FileExtensionsType	自定义文件类型的内置文件类型。
customDelimiter	string	自定义文件类型的自定义分隔符。

DataSourceType

数据源类型。

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

ErrorModel

错误模型。

名称	类型	说明
code	string	标识特定错误的唯一错误代码。
details	ErrorModel[]	提供其他错误详细信息的嵌套 ErrorModel 对象的数组。
message	string	一条可读的错误消息，提供有关错误的更多详细信息。
target	string	与错误关联的特定组件。

ErrorResponseModel

错误响应模型。

名称	类型	说明
error	ErrorModel	错误模型。

FileExtensionsType

自定义文件类型的内置文件类型。

名称	类型	说明
AVRO	string
CSV	string
DOC	string
DOCM	string
DOCX	string
DOT	string
Documents	string
GZ	string
JSON	string
ODP	string
ODS	string
ODT	string
ORC	string
PARQUET	string
PDF	string
POT	string
PPS	string
PPSX	string
PPT	string
PPTM	string
PPTX	string
PSV	string
SSV	string
TSV	string
TXT	string
XLC	string
XLS	string
XLSB	string
XLSM	string
XLSX	string
XLT	string
XML	string

OracleScanRuleset

Oracle 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: Oracle	数据源类型。
name	string	资源名称。
properties	OracleScanRulesetProperties	Oracle 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

OracleScanRulesetProperties

Oracle 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

PowerBIScanRuleset

Power BI 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: PowerBI	数据源类型。
name	string	资源名称。
properties	PowerBIScanRulesetProperties	Power BI 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

PowerBIScanRulesetProperties

Power BI 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

SapEccScanRuleset

SAP ECC 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: SapEcc	数据源类型。
name	string	资源名称。
properties	SapEccScanRulesetProperties	SAP ECC 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

SapEccScanRulesetProperties

SAP ECC 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

SapS4HanaScanRuleset

SAP S/4HANA 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: SapS4Hana	数据源类型。
name	string	资源名称。
properties	SapS4HanaScanRulesetProperties	SAP S/4HANA 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

SapS4HanaScanRulesetProperties

SAP S/4HANA 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

ScanningRule

扫描规则。

名称	类型	说明
customFileExtensions	CustomFileExtension[]	扫描规则的自定义文件扩展名。
fileExtensions	FileExtensionsType[]	扫描规则的文件扩展名。

ScanRulesetStatus

版本控制扫描规则集属性的状态。

名称	类型	说明
Disabled	string
Enabled	string

ScanRulesetType

扫描规则集类型。

名称	类型	说明
Custom	string	扫描规则集类型是自定义的
System	string	扫描规则集类型为系统默认值

SqlServerDatabaseScanRuleset

Sql Server 数据库扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: SqlServerDatabase	数据源类型。
name	string	资源名称。
properties	SqlServerDatabaseScanRulesetProperties	Sql Server 数据库扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

SqlServerDatabaseScanRulesetProperties

Sql Server 数据库扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。

TeradataScanRuleset

Teradata 扫描规则集。

名称	类型	说明
id	string	资源标识符。
kind	string: Teradata	数据源类型。
name	string	资源名称。
properties	TeradataScanRulesetProperties	Teradata 扫描规则集属性。
scanRulesetType	ScanRulesetType	版本控制扫描规则集属性。
status	ScanRulesetStatus	版本控制扫描规则集属性的状态。
version	integer	版本控制扫描规则集属性的版本。

TeradataScanRulesetProperties

Teradata 扫描规则集属性。

名称	类型	说明
createdAt	string	创建扫描规则集的时间。
description	string
excludedSystemClassifications	string[]	从扫描规则集中排除的系统分类。
includedCustomClassificationRuleNames	string[]	扫描规则集中包含的自定义分类规则名称。
lastModifiedAt	string	上次修改扫描规则集的时间。
scanningRule	ScanningRule	扫描规则扫描规则集的扫描规则。

通过

Scan Rulesets - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

ScanRulesets_Get

示例请求

示例响应

定义

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

其他资源