Scans - Get

Gets a scan information.

GET {endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}?api-version=2023-09-01

URI Parameters

Name In Required Type Description
dataSourceName
path True

string

The dataSource name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

endpoint
path True

string

url

The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.

scanName
path True

string

The scan name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

api-version
query True

string

The api version to use.

Responses

Name Type Description
200 OK Scan:

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

Scans_Get

Sample request

GET {endpoint}/scan/datasources/myDataSource/scans/myScanName?api-version=2023-09-01

Sample response

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
{
  "name": "myScanName",
  "dataSourceName": "myDataSource",
  "kind": "AzureStorageCredential",
  "creationType": "Manual",
  "properties": {
    "credential": {
      "referenceName": "CredentialAKV",
      "credentialType": "AccountKey"
    },
    "connectedVia": null,
    "scanRulesetName": "AzureStorage",
    "scanRulesetType": "System",
    "workers": null,
    "collection": {
      "lastModifiedAt": "2021-09-15T21:20:08.2944382Z",
      "referenceName": "Collection-rZX",
      "type": "CollectionReference"
    },
    "domain": "domainName",
    "lastModifiedAt": "2022-08-05T07:25:22.5148717Z"
  }
}

Definitions

Name Description
AdlsGen1CredentialScan

ADLS Gen1 credential scan.

AdlsGen1CredentialScanProperties

ADLS Gen1 credential scan properties.

AdlsGen1MsiScan

ADLS Gen1 MSI scan.

AdlsGen1MsiScanProperties

ADLS Gen1 MSI scan properties.

AdlsGen2CredentialScan

ADLS Gen2 credential scan.

AdlsGen2CredentialScanProperties

ADLS Gen2 credential scan properties.

AdlsGen2MsiScan

ADLS Gen2 MSI scan.

AdlsGen2MsiScanProperties

ADLS Gen2 MSI scan properties.

AmazonAccountCredentialScan

Amazon account credential scan.

AmazonAccountCredentialScanProperties

Amazon account credential scan properties.

AmazonPostgreSqlCredentialScan

Amazon Postgre SQL credential scan.

AmazonPostgreSqlCredentialScanProperties

Amazon Postgre SQL credential scan properties.

AmazonS3CredentialScan

Amazon S3 credential scan.

AmazonS3CredentialScanProperties

Amazon S3 credential scan properties.

AmazonS3RoleARNScan

Amazon S3 role ARN scan.

AmazonS3RoleARNScanProperties

Amazon S3 role ARN scan properties.

AmazonSqlCredentialScan

Amazon SQL credential scan.

AmazonSqlCredentialScanProperties

Amazon SQL credential scan properties.

AzureCosmosDbCredentialScan

Azure Cosmos DB credential scan.

AzureCosmosDbCredentialScanProperties

Azure Cosmos DB credential scan properties.

AzureDataExplorerCredentialScan

Azure data Explorer credential scan.

AzureDataExplorerCredentialScanProperties

Azure data Explorer credential scan properties.

AzureDataExplorerMsiScan

Azure data Explorer MSI scan.

AzureDataExplorerMsiScanProperties

Azure data Explorer MSI scan properties.

AzureFileServiceCredentialScan

Azure file service credential scan.

AzureFileServiceCredentialScanProperties

Azure file service credential scan properties.

AzureMySqlCredentialScan

Azure MySQL credential scan.

AzureMySqlCredentialScanProperties

Azure MySQL credential scan properties.

AzurePostgreSqlCredentialScan

Azure Postgre SQL credential scan.

AzurePostgreSqlCredentialScanProperties

Azure Postgre SQL credential scan properties.

AzureResourceGroupCredentialScan

Azure resource group credential scan.

AzureResourceGroupCredentialScanProperties

Azure resource group credential scan properties.

AzureResourceGroupMsiScan

Azure resource group MSI scan.

AzureResourceGroupMsiScanProperties

Azure resource group MSI scan properties.

AzureSqlDatabaseCredentialScan

Azure SQL database credential scan.

AzureSqlDatabaseCredentialScanProperties

Azure SQL database credential scan properties.

AzureSqlDatabaseManagedInstanceCredentialScan

Azure SQL database managed instance credential scan.

AzureSqlDatabaseManagedInstanceCredentialScanProperties

Azure SQL database managed instance credential scan properties.

AzureSqlDatabaseManagedInstanceMsiScan

Azure SQL database managed instance MSI scan.

AzureSqlDatabaseManagedInstanceMsiScanProperties

Azure SQL database managed instance MSI scan properties.

AzureSqlDatabaseMsiScan

Azure SQL database MSI scan.

AzureSqlDatabaseMsiScanProperties

Azure SQL database MSI scan properties.

AzureSqlDataWarehouseCredentialScan

Azure SQL data warehouse credential scan.

AzureSqlDataWarehouseCredentialScanProperties

Azure SQL data warehouse credential scan properties.

AzureSqlDataWarehouseMsiScan

Azure SQL data warehouse MSI scan.

AzureSqlDataWarehouseMsiScanProperties

Azure SQL data warehouse MSI scan properties.

AzureStorageCredentialScan

Azure Storage credential scan.

AzureStorageCredentialScanProperties

Azure Storage credential scan properties.

AzureStorageMsiScan

Azure Storage MSI scan.

AzureStorageMsiScanProperties

Azure Storage MSI scan properties.

AzureSubscriptionCredentialScan

Azure subscription credential scan.

AzureSubscriptionCredentialScanProperties

Azure subscription credential scan properties.

AzureSubscriptionMsiScan

Azure subscription MSI scan.

AzureSubscriptionMsiScanProperties

Azure subscription MSI scan properties.

AzureSynapseCredentialScan

Azure synapse credential scan.

AzureSynapseCredentialScanProperties

Azure synapse credential scan properties.

AzureSynapseMsiScan

Azure synapse MSI scan.

AzureSynapseMsiScanProperties

Azure synapse MSI scan properties.

AzureSynapseWorkspaceCredentialScan

Azure synapse workspace credential scan.

AzureSynapseWorkspaceCredentialScanProperties

Azure synapse workspace credential scan properties.

AzureSynapseWorkspaceMsiScan

Azure synapse workspace MSI scan.

AzureSynapseWorkspaceMsiScanProperties

Azure synapse workspace MSI scan properties.

CollectionReference

The reference to collection.

ConnectedVia

The integration runtime reference.

CreationType

The creation type.

CredentialReference

The credential reference.

CredentialType

The type of the credential.

DataSourceIdentifier

The data source identifier.

DataSourceType

The data source type.

DiscoveryExecutionDetails

The discovery execution details.

ErrorModel

The error model.

ErrorResponseModel

The error response model.

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

ExtendedProperties

The extended properties.

IngestionExecutionDetails

The ingestion execution details.

IngestionPhaseStatus

The ingestion status.

ItemPath

The item path.

Notification

The notification model.

OracleOracleCredentialScan

Oracle credential scan.

OracleOracleCredentialScanProperties

Oracle credential scan properties.

OracleOracleUserPassScan

Oracle user pass scan.

OracleOracleUserPassScanProperties

Oracle user pass scan properties.

PowerBIDelegatedScan

Power BI delegated scan.

PowerBIDelegatedScanProperties

Power BI delegated scan properties.

PowerBIMsiScan

Power BI MSI scan.

PowerBIMsiScanProperties

Power BI MSI scan properties.

QualifiedName

The qualified name.

ResourceNameFilter

Resource name filter.

ResourceTypeFilter

Resource type filter.

SapEccSapEccCredentialScan

SAP ECC credential scan.

SapEccSapEccCredentialScanProperties

SAP ECC credential scan properties.

SapEccSapEccUserPassScan

SAP ECC user pass scan.

SapEccSapEccUserPassScanProperties

SAP ECC user pass scan properties.

SapS4HanaSapS4HanaCredentialScan

SAP S/4HANA credential scan.

SapS4HanaSapS4HanaCredentialScanProperties

SAP S/4HANA credential scan properties.

SapS4HanaSapS4HanaUserPassScan

SAP S/4HANA user pass scan.

SapS4HanaSapS4HanaUserPassScanProperties

SAP S/4HANA user pass scan properties.

ScanDiagnostics

The scan diagnostics.

ScanLevelType

Scan level type.

ScanResultWithIngestion

The scan result with ingestion.

ScanRulesetType

The scan ruleset type.

ScanRunStatus

The scan result status.

ScanStatus

The discovery status.

SqlServerDatabaseCredentialScan

SQL server database credential scan.

SqlServerDatabaseCredentialScanProperties

SQL server database credential scan properties.

TeradataTeradataCredentialScan

Teradata credential scan.

TeradataTeradataCredentialScanProperties

Teradata credential scan properties.

TeradataTeradataUserPassScan

Teradata user pass scan.

TeradataTeradataUserPassScanProperties

Teradata user pass scan properties.

TeradataUserPassScan

Teradata user pass scan.

TeradataUserPassScanProperties

Teradata user pass scan properties.

AdlsGen1CredentialScan

ADLS Gen1 credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AdlsGen1Credential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AdlsGen1CredentialScanProperties

ADLS Gen1 credential scan properties.

scanId

string

The scan identifier.

AdlsGen1CredentialScanProperties

ADLS Gen1 credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AdlsGen1MsiScan

ADLS Gen1 MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AdlsGen1Msi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AdlsGen1MsiScanProperties

ADLS Gen1 MSI scan properties.

scanId

string

The scan identifier.

AdlsGen1MsiScanProperties

ADLS Gen1 MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AdlsGen2CredentialScan

ADLS Gen2 credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AdlsGen2Credential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AdlsGen2CredentialScanProperties

ADLS Gen2 credential scan properties.

scanId

string

The scan identifier.

AdlsGen2CredentialScanProperties

ADLS Gen2 credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AdlsGen2MsiScan

ADLS Gen2 MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AdlsGen2Msi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AdlsGen2MsiScanProperties

ADLS Gen2 MSI scan properties.

scanId

string

The scan identifier.

AdlsGen2MsiScanProperties

ADLS Gen2 MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AmazonAccountCredentialScan

Amazon account credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AmazonAccountCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AmazonAccountCredentialScanProperties

Amazon account credential scan properties.

scanId

string

The scan identifier.

AmazonAccountCredentialScanProperties

Amazon account credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AmazonPostgreSqlCredentialScan

Amazon Postgre SQL credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AmazonPostgreSqlCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AmazonPostgreSqlCredentialScanProperties

Amazon Postgre SQL credential scan properties.

scanId

string

The scan identifier.

AmazonPostgreSqlCredentialScanProperties

Amazon Postgre SQL credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

port

integer

The port of Amazon Postgre SQL server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Amazon Postgre SQL server.

vpcEndpointServiceName

string

The vpc endpoint service name of Amazon Postgre SQL server.

workers

integer

The number of workers of the scan.

AmazonS3CredentialScan

Amazon S3 credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AmazonS3Credential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AmazonS3CredentialScanProperties

Amazon S3 credential scan properties.

scanId

string

The scan identifier.

AmazonS3CredentialScanProperties

Amazon S3 credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isMauiScan

boolean

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

roleARN

string

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AmazonS3RoleARNScan

Amazon S3 role ARN scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AmazonS3RoleARN

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AmazonS3RoleARNScanProperties

Amazon S3 role ARN scan properties.

scanId

string

The scan identifier.

AmazonS3RoleARNScanProperties

Amazon S3 role ARN scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isMauiScan

boolean

The flag to indicate whether the scan is a Maui scan or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

roleARN

string

The role ARN of the scan.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AmazonSqlCredentialScan

Amazon SQL credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AmazonSqlCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AmazonSqlCredentialScanProperties

Amazon SQL credential scan properties.

scanId

string

The scan identifier.

AmazonSqlCredentialScanProperties

Amazon SQL credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

port

integer

The port of Amazon SQL server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Amazon SQL server.

vpcEndpointServiceName

string

The VPC endpoint service name of Amazon SQL server.

workers

integer

The number of workers of the scan.

AzureCosmosDbCredentialScan

Azure Cosmos DB credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureCosmosDbCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureCosmosDbCredentialScanProperties

Azure Cosmos DB credential scan properties.

scanId

string

The scan identifier.

AzureCosmosDbCredentialScanProperties

Azure Cosmos DB credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureDataExplorerCredentialScan

Azure data Explorer credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureDataExplorerCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureDataExplorerCredentialScanProperties

Azure data Explorer credential scan properties.

scanId

string

The scan identifier.

AzureDataExplorerCredentialScanProperties

Azure data Explorer credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

database

string

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureDataExplorerMsiScan

Azure data Explorer MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureDataExplorerMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureDataExplorerMsiScanProperties

Azure data Explorer MSI scan properties.

scanId

string

The scan identifier.

AzureDataExplorerMsiScanProperties

Azure data Explorer MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

database

string

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureFileServiceCredentialScan

Azure file service credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureFileServiceCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureFileServiceCredentialScanProperties

Azure file service credential scan properties.

scanId

string

The scan identifier.

AzureFileServiceCredentialScanProperties

Azure file service credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

shareName

string

workers

integer

The number of workers of the scan.

AzureMySqlCredentialScan

Azure MySQL credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureMySqlCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureMySqlCredentialScanProperties

Azure MySQL credential scan properties.

scanId

string

The scan identifier.

AzureMySqlCredentialScanProperties

Azure MySQL credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

port

integer

The port of the Azure MySQL server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of the Azure MySQL server.

workers

integer

The number of workers of the scan.

AzurePostgreSqlCredentialScan

Azure Postgre SQL credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzurePostgreSqlCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzurePostgreSqlCredentialScanProperties

Azure Postgre SQL credential scan properties.

scanId

string

The scan identifier.

AzurePostgreSqlCredentialScanProperties

Azure Postgre SQL credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

port

integer

The port of Azure Postgre SQL server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure Postgre SQL server.

sslMode

integer

The SSL mode of Azure Postgre SQL server.

workers

integer

The number of workers of the scan.

AzureResourceGroupCredentialScan

Azure resource group credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureResourceGroupCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureResourceGroupCredentialScanProperties

Azure resource group credential scan properties.

scanId

string

The scan identifier.

AzureResourceGroupCredentialScanProperties

Azure resource group credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureResourceGroupMsiScan

Azure resource group MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureResourceGroupMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureResourceGroupMsiScanProperties

Azure resource group MSI scan properties.

scanId

string

The scan identifier.

AzureResourceGroupMsiScanProperties

Azure resource group MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSqlDatabaseCredentialScan

Azure SQL database credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDatabaseCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDatabaseCredentialScanProperties

Azure SQL database credential scan properties.

scanId

string

The scan identifier.

AzureSqlDatabaseCredentialScanProperties

Azure SQL database credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureSqlDatabaseManagedInstanceCredentialScan

Azure SQL database managed instance credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDatabaseManagedInstanceCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDatabaseManagedInstanceCredentialScanProperties

Azure SQL database managed instance credential scan properties.

scanId

string

The scan identifier.

AzureSqlDatabaseManagedInstanceCredentialScanProperties

Azure SQL database managed instance credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureSqlDatabaseManagedInstanceMsiScan

Azure SQL database managed instance MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDatabaseManagedInstanceMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDatabaseManagedInstanceMsiScanProperties

Azure SQL database managed instance MSI scan properties.

scanId

string

The scan identifier.

AzureSqlDatabaseManagedInstanceMsiScanProperties

Azure SQL database managed instance MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureSqlDatabaseMsiScan

Azure SQL database MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDatabaseMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDatabaseMsiScanProperties

Azure SQL database MSI scan properties.

scanId

string

The scan identifier.

AzureSqlDatabaseMsiScanProperties

Azure SQL database MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureSqlDataWarehouseCredentialScan

Azure SQL data warehouse credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDataWarehouseCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDataWarehouseCredentialScanProperties

Azure SQL data warehouse credential scan properties.

scanId

string

The scan identifier.

AzureSqlDataWarehouseCredentialScanProperties

Azure SQL data warehouse credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureSqlDataWarehouseMsiScan

Azure SQL data warehouse MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSqlDataWarehouseMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSqlDataWarehouseMsiScanProperties

Azure SQL data warehouse MSI scan properties.

scanId

string

The scan identifier.

AzureSqlDataWarehouseMsiScanProperties

Azure SQL data warehouse MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

AzureStorageCredentialScan

Azure Storage credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureStorageCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureStorageCredentialScanProperties

Azure Storage credential scan properties.

scanId

string

The scan identifier.

AzureStorageCredentialScanProperties

Azure Storage credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureStorageMsiScan

Azure Storage MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureStorageMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureStorageMsiScanProperties

Azure Storage MSI scan properties.

scanId

string

The scan identifier.

AzureStorageMsiScanProperties

Azure Storage MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSubscriptionCredentialScan

Azure subscription credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSubscriptionCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSubscriptionCredentialScanProperties

Azure subscription credential scan properties.

scanId

string

The scan identifier.

AzureSubscriptionCredentialScanProperties

Azure subscription credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSubscriptionMsiScan

Azure subscription MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSubscriptionMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSubscriptionMsiScanProperties

Azure subscription MSI scan properties.

scanId

string

The scan identifier.

AzureSubscriptionMsiScanProperties

Azure subscription MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSynapseCredentialScan

Azure synapse credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSynapseCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSynapseCredentialScanProperties

Azure synapse credential scan properties.

scanId

string

The scan identifier.

AzureSynapseCredentialScanProperties

Azure synapse credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSynapseMsiScan

Azure synapse MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSynapseMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSynapseMsiScanProperties

Azure synapse MSI scan properties.

scanId

string

The scan identifier.

AzureSynapseMsiScanProperties

Azure synapse MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSynapseWorkspaceCredentialScan

Azure synapse workspace credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSynapseWorkspaceCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSynapseWorkspaceCredentialScanProperties

Azure synapse workspace credential scan properties.

scanId

string

The scan identifier.

AzureSynapseWorkspaceCredentialScanProperties

Azure synapse workspace credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

AzureSynapseWorkspaceMsiScan

Azure synapse workspace MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

AzureSynapseWorkspaceMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

AzureSynapseWorkspaceMsiScanProperties

Azure synapse workspace MSI scan properties.

scanId

string

The scan identifier.

AzureSynapseWorkspaceMsiScanProperties

Azure synapse workspace MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

resourceTypes

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

CollectionReference

The reference to collection.

Name Type Description
lastModifiedAt

string

The last modified time of collection reference.

referenceName

string

The reference name of collection reference.

type

string

The type of collection reference.

ConnectedVia

The integration runtime reference.

Name Type Description
integrationRuntimeType

string

The type of the integration runtime.

referenceName

string

The reference name of the integration runtime.

CreationType

The creation type.

Name Type Description
AutoManaged

string

the datasource creation type is auto managed

AutoNative

string

the datasource creation type is auto created, native

Manual

string

the datasource creation type is Manual

CredentialReference

The credential reference.

Name Type Description
credentialType

CredentialType

The type of the credential.

referenceName

string

The reference name of the credential.

CredentialType

The type of the credential.

Name Type Description
AccountKey

string

the credential type is account key

AmazonARN

string

the credential type is amazon ARN

BasicAuth

string

the credential type is basic auth

ConsumerKeyAuth

string

the credential type is Consumer Key Auth

DelegatedAuth

string

the credential type is delegated auth

ManagedIdentity

string

the credential type is managed identity

ServicePrincipal

string

the credential type is service principal

SqlAuth

string

the credential type is sql auth

DataSourceIdentifier

The data source identifier.

Name Type Description
dataSourceName

string

The data source name.

guid

string

The guid.

itemPath

ItemPath

The item path.

qualifiedName

QualifiedName

The qualified name.

resourceId

string

The resource identifier.

DataSourceType

The data source type.

Name Type Description
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

DiscoveryExecutionDetails

The discovery execution details.

Name Type Description
discoveryEndTime

string

The discovery end time.

discoveryStartTime

string

The discovery start time.

isErrorLogAvailable

boolean

Indicates whether the error log is available.

statistics

The discovery statistics.

status

ScanStatus

The discovery status.

ErrorModel

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

The error response model.

Name Type Description
error

ErrorModel

The error model.

ExpandingResourceScanPropertiesResourceTypes

Resource types of scan properties in expanding resources.

Name Type Description
adlsGen1

ResourceTypeFilter

Resource type filter.

adlsGen2

ResourceTypeFilter

Resource type filter.

amazonAccount

ResourceTypeFilter

Resource type filter.

amazonPostgreSql

ResourceTypeFilter

Resource type filter.

amazonS3

ResourceTypeFilter

Resource type filter.

amazonSql

ResourceTypeFilter

Resource type filter.

azureCosmosDb

ResourceTypeFilter

Resource type filter.

azureDataExplorer

ResourceTypeFilter

Resource type filter.

azureFileService

ResourceTypeFilter

Resource type filter.

azureMySql

ResourceTypeFilter

Resource type filter.

azurePostgreSql

ResourceTypeFilter

Resource type filter.

azureResourceGroup

ResourceTypeFilter

Resource type filter.

azureSqlDataWarehouse

ResourceTypeFilter

Resource type filter.

azureSqlDatabase

ResourceTypeFilter

Resource type filter.

azureSqlDatabaseManagedInstance

ResourceTypeFilter

Resource type filter.

azureStorage

ResourceTypeFilter

Resource type filter.

azureSubscription

ResourceTypeFilter

Resource type filter.

azureSynapse

ResourceTypeFilter

Resource type filter.

azureSynapseWorkspace

ResourceTypeFilter

Resource type filter.

none

ResourceTypeFilter

Resource type filter.

oracle

ResourceTypeFilter

Resource type filter.

powerBI

ResourceTypeFilter

Resource type filter.

sapEcc

ResourceTypeFilter

Resource type filter.

sapS4Hana

ResourceTypeFilter

Resource type filter.

sqlServerDatabase

ResourceTypeFilter

Resource type filter.

teradata

ResourceTypeFilter

Resource type filter.

ExtendedProperties

The extended properties.

Name Type Description
resourceGroup

string

The resource group.

subscriptionId

string

The subscription identifier.

IngestionExecutionDetails

The ingestion execution details.

Name Type Description
estimatedTimeRemainingInSeconds

integer

The estimated time remaining in seconds.

ingestionEndTime

string

The ingestion end time.

ingestionStartTime

string

The ingestion start time.

isErrorLogAvailable

boolean

Indicates whether the error log is available.

lastUpdatedAt

string

The last updated time.

statistics

The ingestion statistics.

status

IngestionPhaseStatus

The ingestion status.

IngestionPhaseStatus

The ingestion status.

Name Type Description
Canceled

string

Canceling

string

Failed

string

InProgress

string

None

string

PartialSucceeded

string

Queued

string

SourceUnknown

string

Succeeded

string

ItemPath

The item path.

Name Type Description
extendedProperties

ExtendedProperties

The extended properties.

path

string

The path.

Notification

The notification model.

Name Type Description
code

integer

Notification code.

message

string

Notification message.

OracleOracleCredentialScan

Oracle credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

OracleOracleCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

OracleOracleCredentialScanProperties

Oracle credential scan properties.

scanId

string

The scan identifier.

OracleOracleCredentialScanProperties

Oracle credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

driverLocation

string

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

schema

string

storedProcedureDetails

string

workers

integer

The number of workers of the scan.

OracleOracleUserPassScan

Oracle user pass scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

OracleOracleUserPass

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

OracleOracleUserPassScanProperties

Oracle user pass scan properties.

scanId

string

The scan identifier.

OracleOracleUserPassScanProperties

Oracle user pass scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

driverLocation

string

The driver location.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

password

string

The password of Oracle server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

schema

string

The schema.

username

string

The username of Oracle server.

workers

integer

The number of workers of the scan.

PowerBIDelegatedScan

Power BI delegated scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

PowerBIDelegated

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

PowerBIDelegatedScanProperties

Power BI delegated scan properties.

scanId

string

The scan identifier.

PowerBIDelegatedScanProperties

Power BI delegated scan properties.

Name Type Description
authenticationType

string

businessRuleSetName

string

The name of the business rule set.

clientId

string

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

includePersonalWorkspaces

boolean

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

password

string

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

tenant

string

userName

string

workers

integer

The number of workers of the scan.

PowerBIMsiScan

Power BI MSI scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

PowerBIMsi

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

PowerBIMsiScanProperties

Power BI MSI scan properties.

scanId

string

The scan identifier.

PowerBIMsiScanProperties

Power BI MSI scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

includePersonalWorkspaces

boolean

Whether to include personal workspaces or not.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

QualifiedName

The qualified name.

Name Type Description
extendedProperties

ExtendedProperties

The extended properties.

name

string

The name.

typeName

string

The type name.

ResourceNameFilter

Resource name filter.

Name Type Description
excludePrefixes

string[]

includePrefixes

string[]

resources

string[]

ResourceTypeFilter

Resource type filter.

Name Type Description
credential

CredentialReference

The credential reference.

resourceNameFilter

ResourceNameFilter

Resource name filter.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

SapEccSapEccCredentialScan

SAP ECC credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

SapEccSapEccCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

SapEccSapEccCredentialScanProperties

SAP ECC credential scan properties.

scanId

string

The scan identifier.

SapEccSapEccCredentialScanProperties

SAP ECC credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

clientId

string

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

jCoLibraryPath

string

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

SapEccSapEccUserPassScan

SAP ECC user pass scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

SapEccSapEccUserPass

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

SapEccSapEccUserPassScanProperties

SAP ECC user pass scan properties.

scanId

string

The scan identifier.

SapEccSapEccUserPassScanProperties

SAP ECC user pass scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

clientId

string

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

jCoLibraryPath

string

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

password

string

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

username

string

workers

integer

The number of workers of the scan.

SapS4HanaSapS4HanaCredentialScan

SAP S/4HANA credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

SapS4HanaSapS4HanaCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

SapS4HanaSapS4HanaCredentialScanProperties

SAP S/4HANA credential scan properties.

scanId

string

The scan identifier.

SapS4HanaSapS4HanaCredentialScanProperties

SAP S/4HANA credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

clientId

string

The client ID of SAP S/4HANA server.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

jCoLibraryPath

string

The JCo library path.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

workers

integer

The number of workers of the scan.

SapS4HanaSapS4HanaUserPassScan

SAP S/4HANA user pass scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

SapS4HanaSapS4HanaUserPass

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

SapS4HanaSapS4HanaUserPassScanProperties

SAP S/4HANA user pass scan properties.

scanId

string

The scan identifier.

SapS4HanaSapS4HanaUserPassScanProperties

SAP S/4HANA user pass scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

clientId

string

The client ID of SAP S/4HANA server.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

jCoLibraryPath

string

The JCo library path.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

password

string

The password of SAP S/4HANA server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

username

string

The username of SAP S/4HANA server.

workers

integer

The number of workers of the scan.

ScanDiagnostics

The scan diagnostics.

Name Type Description
exceptionCountMap

object

Exception count map.

notifications

Notification[]

Notifications.

ScanLevelType

Scan level type.

Name Type Description
Full

string

the scan is full scan

Incremental

string

the scan is incremental scan

ScanResultWithIngestion

The scan result with ingestion.

Name Type Description
dataSourceType

DataSourceType

The data source type.

diagnostics

ScanDiagnostics

The scan diagnostics.

discoveryExecutionDetails

DiscoveryExecutionDetails

The discovery execution details.

endTime

string

The scan end time.

error

ErrorModel

The error.

errorMessage

string

The error message.

id

string

The scan result identifier.

ingestionExecutionDetails

IngestionExecutionDetails

The ingestion execution details.

ingestionJobId

string

The ingestion job identifier.

parentId

string

The parent scan result identifier.

resourceId

string

The resource identifier.

runType

string

The run type.

scanLevelType

ScanLevelType

Scan level type.

scanRulesetType

ScanRulesetType

The scan ruleset type.

scanRulesetVersion

integer

The scan ruleset version.

startTime

string

The scan start time.

status

ScanRunStatus

The scan result status.

ScanRulesetType

The scan ruleset type.

Name Type Description
Custom

string

the scan ruleset type is custom

System

string

the scan ruleset type is system default

ScanRunStatus

The scan result status.

Name Type Description
Accepted

string

the scan is accepted

Canceled

string

the scan is canceled

Failed

string

the scan is failed

InProgress

string

the scan is InProgress

Succeeded

string

the scan is succeeded

TransientFailure

string

the scan is in transient failure

ScanStatus

The discovery status.

Name Type Description
Cancelled

string

CompleteWithWarning

string

CompletedWithExceptions

string

Delayed

string

Failed

string

Queued

string

Running

string

Succeeded

string

Throttled

string

SqlServerDatabaseCredentialScan

SQL server database credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

SqlServerDatabaseCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

SqlServerDatabaseCredentialScanProperties

SQL server database credential scan properties.

scanId

string

The scan identifier.

SqlServerDatabaseCredentialScanProperties

SQL server database credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

databaseName

string

The database name.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

serverEndpoint

string

The endpoint of Azure SQL server.

workers

integer

The number of workers of the scan.

TeradataTeradataCredentialScan

Teradata credential scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

TeradataTeradataCredential

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

TeradataTeradataCredentialScanProperties

Teradata credential scan properties.

scanId

string

The scan identifier.

TeradataTeradataCredentialScanProperties

Teradata credential scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

credential

CredentialReference

The credential reference.

domain

string

The domain of the scan.

driverLocation

string

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

schema

string

storedProcedureDetails

string

workers

integer

The number of workers of the scan.

TeradataTeradataUserPassScan

Teradata user pass scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

TeradataTeradataUserPass

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

TeradataTeradataUserPassScanProperties

Teradata user pass scan properties.

scanId

string

The scan identifier.

TeradataTeradataUserPassScanProperties

Teradata user pass scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

driverLocation

string

The driver location.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

maximumMemoryAllowedInGb

string

The maximum memory allowed in GB.

mitiCache

string

The miti cache.

parallelScanCount

integer

The number of parallel scans.

password

string

The password of Teradata server.

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

schema

string

The schema.

username

string

The username of Teradata server.

workers

integer

The number of workers of the scan.

TeradataUserPassScan

Teradata user pass scan.

Name Type Description
creationType

CreationType

The creation type.

dataSourceIdentifier

DataSourceIdentifier

The data source identifier.

dataSourceName

string

The data source name.

id

string

The resource identifier.

kind string:

TeradataUserPass

The properties of scan, vary by datasource type.

lastRunResult

ScanResultWithIngestion

The scan result with ingestion.

name

string

The resource name.

properties

TeradataUserPassScanProperties

Teradata user pass scan properties.

scanId

string

The scan identifier.

TeradataUserPassScanProperties

Teradata user pass scan properties.

Name Type Description
businessRuleSetName

string

The name of the business rule set.

collection

CollectionReference

The collection reference of the scan.

connectedVia

ConnectedVia

The integration runtime reference of the scan.

createdAt

string

The creation time of the scan.

domain

string

The domain of the scan.

isLiveViewEnabled

boolean

The flag to indicate whether the live view is enabled or not.

isPresetScan

boolean

The flag to indicate whether the scan is a preset scan or not.

lastModifiedAt

string

The last modified time of the scan.

logLevel

string

The log level of the scan.

parallelScanCount

integer

The number of parallel scans.

password

string

scanRulesetName

string

The name of the scan ruleset.

scanRulesetType

ScanRulesetType

The type of the scan ruleset.

username

string

workers

integer

The number of workers of the scan.