Scans - Create Or Update

Service:

Purview

API Version:

2022-07-01-preview

Creates an instance of a scan

PUT {Endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}?api-version=2022-07-01-preview

URI Parameters

Name	In	Required	Type	Description
dataSourceName	path	True	string
Endpoint	path	True	string	The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com
scanName	path	True	string
api-version	query	True	string	The api version to use.

Request Body

The request body can be one of the following:

Name	Description
AdlsGen1CredentialScan
AdlsGen1MsiScan
AdlsGen2CredentialScan
AdlsGen2MsiScan
AmazonAccountCredentialScan
AmazonPostgreSqlCredentialScan
AmazonS3CredentialScan
AmazonS3RoleARNScan
AmazonSqlCredentialScan
AzureCosmosDbCredentialScan
AzureDataExplorerCredentialScan
AzureDataExplorerMsiScan
AzureFileServiceCredentialScan
AzureMySqlCredentialScan
AzurePostgreSqlCredentialScan
AzureResourceGroupCredentialScan
AzureResourceGroupMsiScan
AzureSqlDatabaseCredentialScan
AzureSqlDatabaseManagedInstanceCredentialScan
AzureSqlDatabaseManagedInstanceMsiScan
AzureSqlDatabaseMsiScan
AzureSqlDataWarehouseCredentialScan
AzureSqlDataWarehouseMsiScan
AzureStorageCredentialScan
AzureStorageMsiScan
AzureSubscriptionCredentialScan
AzureSubscriptionMsiScan
AzureSynapseCredentialScan
AzureSynapseMsiScan
AzureSynapseWorkspaceCredentialScan
AzureSynapseWorkspaceMsiScan
OracleOracleCredentialScan
OracleOracleUserPassScan
PowerBIDelegatedScan
PowerBIMsiScan
SapEccSapEccCredentialScan
SapEccSapEccUserPassScan
SapS4HanaSapS4HanaCredentialScan
SapS4HanaSapS4HanaUserPassScan
SqlServerDatabaseCredentialScan
TeradataTeradataCredentialScan
TeradataTeradataUserPassScan
TeradataUserPassScan

AdlsGen1CredentialScan

Name	Required	Type	Description
kind	True	string: AdlsGen1Credential
properties		Properties

AdlsGen1MsiScan

Name	Required	Type	Description
kind	True	string: AdlsGen1Msi
properties		Properties

AdlsGen2CredentialScan

Name	Required	Type	Description
kind	True	string: AdlsGen2Credential
properties		Properties

AdlsGen2MsiScan

Name	Required	Type	Description
kind	True	string: AdlsGen2Msi
properties		Properties

AmazonAccountCredentialScan

Name	Required	Type	Description
kind	True	string: AmazonAccountCredential
properties		Properties

AmazonPostgreSqlCredentialScan

Name	Required	Type	Description
kind	True	string: AmazonPostgreSqlCredential
properties		Properties

AmazonS3CredentialScan

Name	Required	Type	Description
kind	True	string: AmazonS3Credential
properties		Properties

AmazonS3RoleARNScan

Name	Required	Type	Description
kind	True	string: AmazonS3RoleARN
properties		Properties

AmazonSqlCredentialScan

Name	Required	Type	Description
kind	True	string: AmazonSqlCredential
properties		Properties

AzureCosmosDbCredentialScan

Name	Required	Type	Description
kind	True	string: AzureCosmosDbCredential
properties		Properties

AzureDataExplorerCredentialScan

Name	Required	Type	Description
kind	True	string: AzureDataExplorerCredential
properties		Properties

AzureDataExplorerMsiScan

Name	Required	Type	Description
kind	True	string: AzureDataExplorerMsi
properties		Properties

AzureFileServiceCredentialScan

Name	Required	Type	Description
kind	True	string: AzureFileServiceCredential
properties		Properties

AzureMySqlCredentialScan

Name	Required	Type	Description
kind	True	string: AzureMySqlCredential
properties		Properties

AzurePostgreSqlCredentialScan

Name	Required	Type	Description
kind	True	string: AzurePostgreSqlCredential
properties		Properties

AzureResourceGroupCredentialScan

Name	Required	Type	Description
kind	True	string: AzureResourceGroupCredential
properties		Properties

AzureResourceGroupMsiScan

Name	Required	Type	Description
kind	True	string: AzureResourceGroupMsi
properties		Properties

AzureSqlDatabaseCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSqlDatabaseCredential
properties		Properties

AzureSqlDatabaseManagedInstanceCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSqlDatabaseManagedInstanceCredential
properties		Properties

AzureSqlDatabaseManagedInstanceMsiScan

Name	Required	Type	Description
kind	True	string: AzureSqlDatabaseManagedInstanceMsi
properties		Properties

AzureSqlDatabaseMsiScan

Name	Required	Type	Description
kind	True	string: AzureSqlDatabaseMsi
properties		Properties

AzureSqlDataWarehouseCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSqlDataWarehouseCredential
properties		Properties

AzureSqlDataWarehouseMsiScan

Name	Required	Type	Description
kind	True	string: AzureSqlDataWarehouseMsi
properties		Properties

AzureStorageCredentialScan

Name	Required	Type	Description
kind	True	string: AzureStorageCredential
properties		Properties

AzureStorageMsiScan

Name	Required	Type	Description
kind	True	string: AzureStorageMsi
properties		Properties

AzureSubscriptionCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSubscriptionCredential
properties		Properties

AzureSubscriptionMsiScan

Name	Required	Type	Description
kind	True	string: AzureSubscriptionMsi
properties		Properties

AzureSynapseCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSynapseCredential
properties		Properties

AzureSynapseMsiScan

Name	Required	Type	Description
kind	True	string: AzureSynapseMsi
properties		Properties

AzureSynapseWorkspaceCredentialScan

Name	Required	Type	Description
kind	True	string: AzureSynapseWorkspaceCredential
properties		Properties

AzureSynapseWorkspaceMsiScan

Name	Required	Type	Description
kind	True	string: AzureSynapseWorkspaceMsi
properties		Properties

OracleOracleCredentialScan

Name	Required	Type	Description
kind	True	string: OracleOracleCredential
properties		Properties

OracleOracleUserPassScan

Name	Required	Type	Description
kind	True	string: OracleOracleUserPass
properties		Properties

PowerBIDelegatedScan

Name	Required	Type	Description
kind	True	string: PowerBIDelegated
properties		Properties

PowerBIMsiScan

Name	Required	Type	Description
kind	True	string: PowerBIMsi
properties		Properties

SapEccSapEccCredentialScan

Name	Required	Type	Description
kind	True	string: SapEccSapEccCredential
properties		Properties

SapEccSapEccUserPassScan

Name	Required	Type	Description
kind	True	string: SapEccSapEccUserPass
properties		Properties

SapS4HanaSapS4HanaCredentialScan

Name	Required	Type	Description
kind	True	string: SapS4HanaSapS4HanaCredential
properties		Properties

SapS4HanaSapS4HanaUserPassScan

Name	Required	Type	Description
kind	True	string: SapS4HanaSapS4HanaUserPass
properties		Properties

SqlServerDatabaseCredentialScan

Name	Required	Type	Description
kind	True	string: SqlServerDatabaseCredential
properties		Properties

TeradataTeradataCredentialScan

Name	Required	Type	Description
kind	True	string: TeradataTeradataCredential
properties		Properties

TeradataTeradataUserPassScan

Name	Required	Type	Description
kind	True	string: TeradataTeradataUserPass
properties		Properties

TeradataUserPassScan

Name	Required	Type	Description
kind	True	string: TeradataUserPass
properties		Properties

Responses

Name	Type	Description
200 OK	Scan: AzureSubscriptionCredentialScan AzureSubscriptionMsiScan AzureResourceGroupCredentialScan AzureResourceGroupMsiScan AzureSynapseWorkspaceCredentialScan AzureSynapseWorkspaceMsiScan AzureSynapseCredentialScan AzureSynapseMsiScan AdlsGen1CredentialScan AdlsGen1MsiScan AdlsGen2CredentialScan AdlsGen2MsiScan AmazonAccountCredentialScan AmazonS3CredentialScan AmazonS3RoleARNScan AmazonSqlCredentialScan AzureCosmosDbCredentialScan AzureDataExplorerCredentialScan AzureDataExplorerMsiScan AzureFileServiceCredentialScan AzureSqlDatabaseCredentialScan AzureSqlDatabaseMsiScan AmazonPostgreSqlCredentialScan AzurePostgreSqlCredentialScan SqlServerDatabaseCredentialScan AzureSqlDatabaseManagedInstanceCredentialScan AzureSqlDatabaseManagedInstanceMsiScan AzureSqlDataWarehouseCredentialScan AzureSqlDataWarehouseMsiScan AzureMySqlCredentialScan AzureStorageCredentialScan AzureStorageMsiScan TeradataTeradataCredentialScan TeradataUserPassScan TeradataTeradataUserPassScan OracleOracleCredentialScan OracleOracleUserPassScan SapS4HanaSapS4HanaCredentialScan SapS4HanaSapS4HanaUserPassScan SapEccSapEccCredentialScan SapEccSapEccUserPassScan PowerBIDelegatedScan PowerBIMsiScan	Success
201 Created	Scan: AzureSubscriptionCredentialScan AzureSubscriptionMsiScan AzureResourceGroupCredentialScan AzureResourceGroupMsiScan AzureSynapseWorkspaceCredentialScan AzureSynapseWorkspaceMsiScan AzureSynapseCredentialScan AzureSynapseMsiScan AdlsGen1CredentialScan AdlsGen1MsiScan AdlsGen2CredentialScan AdlsGen2MsiScan AmazonAccountCredentialScan AmazonS3CredentialScan AmazonS3RoleARNScan AmazonSqlCredentialScan AzureCosmosDbCredentialScan AzureDataExplorerCredentialScan AzureDataExplorerMsiScan AzureFileServiceCredentialScan AzureSqlDatabaseCredentialScan AzureSqlDatabaseMsiScan AmazonPostgreSqlCredentialScan AzurePostgreSqlCredentialScan SqlServerDatabaseCredentialScan AzureSqlDatabaseManagedInstanceCredentialScan AzureSqlDatabaseManagedInstanceMsiScan AzureSqlDataWarehouseCredentialScan AzureSqlDataWarehouseMsiScan AzureMySqlCredentialScan AzureStorageCredentialScan AzureStorageMsiScan TeradataTeradataCredentialScan TeradataUserPassScan TeradataTeradataUserPassScan OracleOracleCredentialScan OracleOracleUserPassScan SapS4HanaSapS4HanaCredentialScan SapS4HanaSapS4HanaUserPassScan SapEccSapEccCredentialScan SapEccSapEccUserPassScan PowerBIDelegatedScan PowerBIMsiScan	Success
Other Status Codes	ErrorResponseModel	An error response received from the Scanning Service

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_CreateOrUpdate

Sample Request

HTTP

PUT {Endpoint}/scan/datasources/myDataSource/scans/myScanName?api-version=2022-07-01-preview

{
  "kind": "AzureStorageCredential",
  "properties": {
    "credential": {
      "referenceName": "CredentialAKV",
      "credentialType": "AccountKey"
    },
    "connectedVia": null,
    "scanRulesetName": "AzureStorage",
    "scanRulesetType": "System",
    "collection": {
      "referenceName": "Collection-rZX"
    }
  }
}

Sample Response

Status code:

200

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

Response Body

{
  "name": "myScanName",
  "id": "datasources/myDataSource/scans/myScanName",
  "kind": "AzureStorageCredential",
  "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"
    }
  },
  "scanResults": null
}

Status code:

201

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

Response Body

{
  "name": "myScanName",
  "id": "datasources/myDataSource/scans/myScanName",
  "kind": "AzureStorageCredential",
  "properties": {
    "credential": {
      "referenceName": "CredentialAKV",
      "credentialType": "AccountKey"
    },
    "scanRulesetName": "AzureStorage",
    "scanRulesetType": "System",
    "workers": null,
    "collection": {
      "lastModifiedAt": "2021-09-15T21:20:08.2944382Z",
      "referenceName": "Collection-rZX",
      "type": "CollectionReference"
    }
  },
  "scanResults": null
}

Definitions

Name	Description
AdlsGen1CredentialScan
AdlsGen1MsiScan
AdlsGen2CredentialScan
AdlsGen2MsiScan
AmazonAccountCredentialScan
AmazonPostgreSqlCredentialScan
AmazonS3CredentialScan
AmazonS3RoleARNScan
AmazonSqlCredentialScan
AzureCosmosDbCredentialScan
AzureDataExplorerCredentialScan
AzureDataExplorerMsiScan
AzureFileServiceCredentialScan
AzureMySqlCredentialScan
AzurePostgreSqlCredentialScan
AzureResourceGroupCredentialScan
AzureResourceGroupMsiScan
AzureSqlDatabaseCredentialScan
AzureSqlDatabaseManagedInstanceCredentialScan
AzureSqlDatabaseManagedInstanceMsiScan
AzureSqlDatabaseMsiScan
AzureSqlDataWarehouseCredentialScan
AzureSqlDataWarehouseMsiScan
AzureStorageCredentialScan
AzureStorageMsiScan
AzureSubscriptionCredentialScan
AzureSubscriptionMsiScan
AzureSynapseCredentialScan
AzureSynapseMsiScan
AzureSynapseWorkspaceCredentialScan
AzureSynapseWorkspaceMsiScan
DataSourceType
Diagnostics
Error
ErrorModel
ErrorResponseModel
Notification
OracleOracleCredentialScan
OracleOracleUserPassScan
PowerBIDelegatedScan
PowerBIMsiScan
Properties
SapEccSapEccCredentialScan
SapEccSapEccUserPassScan
SapS4HanaSapS4HanaCredentialScan
SapS4HanaSapS4HanaUserPassScan
ScanLevelType
ScanResult
ScanRulesetType
SqlServerDatabaseCredentialScan
TeradataTeradataCredentialScan
TeradataTeradataUserPassScan
TeradataUserPassScan

AdlsGen1CredentialScan

Name	Type	Description
id	string
kind	string: AdlsGen1Credential
name	string
properties	Properties
scanResults	ScanResult[]

AdlsGen1MsiScan

Name	Type	Description
id	string
kind	string: AdlsGen1Msi
name	string
properties	Properties
scanResults	ScanResult[]

AdlsGen2CredentialScan

Name	Type	Description
id	string
kind	string: AdlsGen2Credential
name	string
properties	Properties
scanResults	ScanResult[]

AdlsGen2MsiScan

Name	Type	Description
id	string
kind	string: AdlsGen2Msi
name	string
properties	Properties
scanResults	ScanResult[]

AmazonAccountCredentialScan

Name	Type	Description
id	string
kind	string: AmazonAccountCredential
name	string
properties	Properties
scanResults	ScanResult[]

AmazonPostgreSqlCredentialScan

Name	Type	Description
id	string
kind	string: AmazonPostgreSqlCredential
name	string
properties	Properties
scanResults	ScanResult[]

AmazonS3CredentialScan

Name	Type	Description
id	string
kind	string: AmazonS3Credential
name	string
properties	Properties
scanResults	ScanResult[]

AmazonS3RoleARNScan

Name	Type	Description
id	string
kind	string: AmazonS3RoleARN
name	string
properties	Properties
scanResults	ScanResult[]

AmazonSqlCredentialScan

Name	Type	Description
id	string
kind	string: AmazonSqlCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureCosmosDbCredentialScan

Name	Type	Description
id	string
kind	string: AzureCosmosDbCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureDataExplorerCredentialScan

Name	Type	Description
id	string
kind	string: AzureDataExplorerCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureDataExplorerMsiScan

Name	Type	Description
id	string
kind	string: AzureDataExplorerMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureFileServiceCredentialScan

Name	Type	Description
id	string
kind	string: AzureFileServiceCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureMySqlCredentialScan

Name	Type	Description
id	string
kind	string: AzureMySqlCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzurePostgreSqlCredentialScan

Name	Type	Description
id	string
kind	string: AzurePostgreSqlCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureResourceGroupCredentialScan

Name	Type	Description
id	string
kind	string: AzureResourceGroupCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureResourceGroupMsiScan

Name	Type	Description
id	string
kind	string: AzureResourceGroupMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDatabaseCredentialScan

Name	Type	Description
id	string
kind	string: AzureSqlDatabaseCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDatabaseManagedInstanceCredentialScan

Name	Type	Description
id	string
kind	string: AzureSqlDatabaseManagedInstanceCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDatabaseManagedInstanceMsiScan

Name	Type	Description
id	string
kind	string: AzureSqlDatabaseManagedInstanceMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDatabaseMsiScan

Name	Type	Description
id	string
kind	string: AzureSqlDatabaseMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDataWarehouseCredentialScan

Name	Type	Description
id	string
kind	string: AzureSqlDataWarehouseCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSqlDataWarehouseMsiScan

Name	Type	Description
id	string
kind	string: AzureSqlDataWarehouseMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureStorageCredentialScan

Name	Type	Description
id	string
kind	string: AzureStorageCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureStorageMsiScan

Name	Type	Description
id	string
kind	string: AzureStorageMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSubscriptionCredentialScan

Name	Type	Description
id	string
kind	string: AzureSubscriptionCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSubscriptionMsiScan

Name	Type	Description
id	string
kind	string: AzureSubscriptionMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSynapseCredentialScan

Name	Type	Description
id	string
kind	string: AzureSynapseCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSynapseMsiScan

Name	Type	Description
id	string
kind	string: AzureSynapseMsi
name	string
properties	Properties
scanResults	ScanResult[]

AzureSynapseWorkspaceCredentialScan

Name	Type	Description
id	string
kind	string: AzureSynapseWorkspaceCredential
name	string
properties	Properties
scanResults	ScanResult[]

AzureSynapseWorkspaceMsiScan

Name	Type	Description
id	string
kind	string: AzureSynapseWorkspaceMsi
name	string
properties	Properties
scanResults	ScanResult[]

DataSourceType

Name	Type	Description
AdlsGen1	string
AdlsGen2	string
AmazonAccount	string
AmazonPostgreSql	string
AmazonS3	string
AmazonSql	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
None	string
Oracle	string
PowerBI	string
SapEcc	string
SapS4Hana	string
SqlServerDatabase	string
Teradata	string

Diagnostics

Name	Type	Description
exceptionCountMap	object
notifications	Notification[]

Error

Name	Type	Description
code	string
details	ErrorModel[]
message	string
target	string

ErrorModel

Name	Type	Description
code	string
details	ErrorModel[]
message	string
target	string

ErrorResponseModel

Name	Type	Description
error	Error

Notification

Name	Type	Description
code	integer
message	string

OracleOracleCredentialScan

Name	Type	Description
id	string
kind	string: OracleOracleCredential
name	string
properties	Properties
scanResults	ScanResult[]

OracleOracleUserPassScan

Name	Type	Description
id	string
kind	string: OracleOracleUserPass
name	string
properties	Properties
scanResults	ScanResult[]

PowerBIDelegatedScan

Name	Type	Description
id	string
kind	string: PowerBIDelegated
name	string
properties	Properties
scanResults	ScanResult[]

PowerBIMsiScan

Name	Type	Description
id	string
kind	string: PowerBIMsi
name	string
properties	Properties
scanResults	ScanResult[]

Properties

Name	Type	Description
baseUrl	string
description	string

SapEccSapEccCredentialScan

Name	Type	Description
id	string
kind	string: SapEccSapEccCredential
name	string
properties	Properties
scanResults	ScanResult[]

SapEccSapEccUserPassScan

Name	Type	Description
id	string
kind	string: SapEccSapEccUserPass
name	string
properties	Properties
scanResults	ScanResult[]

SapS4HanaSapS4HanaCredentialScan

Name	Type	Description
id	string
kind	string: SapS4HanaSapS4HanaCredential
name	string
properties	Properties
scanResults	ScanResult[]

SapS4HanaSapS4HanaUserPassScan

Name	Type	Description
id	string
kind	string: SapS4HanaSapS4HanaUserPass
name	string
properties	Properties
scanResults	ScanResult[]

ScanLevelType

Name	Type	Description
Full	string
Incremental	string

ScanResult

Name	Type	Description
assetsClassified	integer
assetsDiscovered	integer
dataSourceType	DataSourceType
diagnostics	Diagnostics
endTime	string
error	Error
errorMessage	string
id	string
parentId	string
pipelineStartTime	string
queuedTime	string
resourceId	string
runType	string
scanLevelType	ScanLevelType
scanRulesetType	ScanRulesetType
scanRulesetVersion	integer
startTime	string
status	string

ScanRulesetType

Name	Type	Description
Custom	string
System	string

SqlServerDatabaseCredentialScan

Name	Type	Description
id	string
kind	string: SqlServerDatabaseCredential
name	string
properties	Properties
scanResults	ScanResult[]

TeradataTeradataCredentialScan

Name	Type	Description
id	string
kind	string: TeradataTeradataCredential
name	string
properties	Properties
scanResults	ScanResult[]

TeradataTeradataUserPassScan

Name	Type	Description
id	string
kind	string: TeradataTeradataUserPass
name	string
properties	Properties
scanResults	ScanResult[]

TeradataUserPassScan

Name	Type	Description
id	string
kind	string: TeradataUserPass
name	string
properties	Properties
scanResults	ScanResult[]