MicrosoftScanningClient (preview:2022-07-01)

2025/12/05 • 56 new methods

KeyVaultConnections_Get (new)
Description :  Gets azureKeyVault information
Reference :  Link ¶

⚼ Request

GET:  /azureKeyVaults/{azureKeyVaultName}
{
azureKeyVaultName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
KeyVaultConnections_Create (new)
Description :  Creates an instance of a azureKeyVault
Reference :  Link ¶

⚼ Request

PUT:  /azureKeyVaults/{azureKeyVaultName}
{
azureKeyVaultName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
KeyVaultConnections_Delete (new)
Description :  Deletes the azureKeyVault associated with the account
Reference :  Link ¶

⚼ Request

DELETE:  /azureKeyVaults/{azureKeyVaultName}
{
azureKeyVaultName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
KeyVaultConnections_ListAll (new)
Description :  List azureKeyVaults in account
Reference :  Link ¶

⚼ Request

GET:  /azureKeyVaults
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
properties:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_Get (new)
Description :  Get a classification rule
Reference :  Link ¶

⚼ Request

GET:  /classificationrules/{classificationRuleName}
{
classificationRuleName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_CreateOrUpdate (new)
Description :  Creates or Updates a classification rule
Reference :  Link ¶

⚼ Request

PUT:  /classificationrules/{classificationRuleName}
{
classificationRuleName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_Delete (new)
Description :  Deletes a classification rule
Reference :  Link ¶

⚼ Request

DELETE:  /classificationrules/{classificationRuleName}
{
classificationRuleName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_ListAll (new)
Description :  List classification rules in Account
Reference :  Link ¶

⚼ Request

GET:  /classificationrules
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_ListVersionsByClassificationRuleName (new)
Description :  Lists the rule versions of a classification rule
Reference :  Link ¶

⚼ Request

GET:  /classificationrules/{classificationRuleName}/versions
{
classificationRuleName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
System: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ClassificationRules_TagClassificationVersion (new)
Description :  Sets Classification Action on a specific classification rule version.
Reference :  Link ¶

⚼ Request

POST:  /classificationrules/{classificationRuleName}/versions/{classificationRuleVersion}/:tag
{
classificationRuleName:
{
Required: True ,
}
string ,
classificationRuleVersion:
{
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
scanResultId:
{
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
status:
{
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Scans_ListByCollection (new)
Description :  List scans of the collection
Reference :  Link ¶

⚼ Request

GET:  /collections/{collectionName}/scans
{
collectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
collectionName:
{
Required: False ,
}
string ,
dataSourceName:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
scanName:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Credential_Get (new)
Description :  Gets credential information
Reference :  Link ¶

⚼ Request

GET:  /credentials/{credentialName}
{
credentialName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Credential_CreateOrUpdate (new)
Description :  Creates an instance of a credential
Reference :  Link ¶

⚼ Request

PUT:  /credentials/{credentialName}
{
credentialName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Credential_Delete (new)
Description :  Deletes the credentials associated with the account
Reference :  Link ¶

⚼ Request

DELETE:  /credentials/{credentialName}
{
credentialName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Credential_ListAll (new)
Description :  List credentials in account
Reference :  Link ¶

⚼ Request

GET:  /credentials
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
BasicAuth: No description available. ,
SqlAuth: No description available. ,
AmazonARN: No description available. ,
ConsumerKeyAuth: No description available. ,
DelegatedAuth: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
DataSources_CreateOrUpdate (new)
Description :  Creates or Updates a data source
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}
{
dataSourceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (201)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
DataSources_Get (new)
Description :  Get a data source
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}
{
dataSourceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
DataSources_Delete (new)
Description :  Deletes a data source
Reference :  Link ¶

⚼ Request

DELETE:  /datasources/{dataSourceName}
{
dataSourceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
DataSources_ListAll (new)
Description :  List data sources in Data catalog
Reference :  Link ¶

⚼ Request

GET:  /datasources
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Required: False ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Filters_Get (new)
Description :  Get a filter
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans/{scanName}/filters/custom
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Filters_CreateOrUpdate (new)
Description :  Creates or updates a filter
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}/filters/custom
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_Get (new)
Description :  Gets an integrationRuntime
Reference :  Link ¶

⚼ Request

GET:  /integrationruntimes/{integrationRuntimeName}
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_Delete (new)
Description :  Deletes an integrationRuntime
Reference :  Link ¶

⚼ Request

DELETE:  /integrationruntimes/{integrationRuntimeName}
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_CreateOrReplace (new)
Description :  Create or replace an instance of a integrationRuntime
Reference :  Link ¶

⚼ Request

PUT:  /integrationruntimes/{integrationRuntimeName}
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_Status (new)
Description :  Gets an IntegrationRuntimeStatus object. This is significantly different from IntegrationRuntime
Reference :  Link ¶

⚼ Request

GET:  /integrationruntimes/{integrationRuntimeName}/status
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_ListAuthKeys (new)
Description :  Gets integrationRuntimeAuthKeys
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}/:listAuthKeys
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authKey1:
{
Required: False ,
}
string ,
authKey2:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_RegenerateAuthKey (new)
Description :  Regenerates integrationRuntimeAuthKey
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}/:regenerateAuthKey
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
keyName:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
authKey1:
{
Required: False ,
}
string ,
authKey2:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_ListByAccount (new)
Description :  Lists integrationruntimes in an account
Reference :  Link ¶

⚼ Request

GET:  /integrationruntimes
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
SelfHosted: No description available. ,
Managed: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_DisableInteractiveQuery (new)
Description :  Disables interactive querying
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}:disableInteractiveQuery
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
IntegrationRuntimes_EnableInteractiveQuery (new)
Description :  Enables interactive querying
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}:enableInteractiveQuery
{
integrationRuntimeName:
{
Description: IntegrationRuntime name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
autoTerminationMinutes:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_Get (new)
Description :  Gets a ManagedVirtualNetwork
Reference :  Link ¶

⚼ Request

GET:  /managedvirtualnetworks/{managedVirtualNetworkName}
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_CreateOrReplace (new)
Description :  Create or replace a ManagedVirtualNetwork
Reference :  Link ¶

⚼ Request

PUT:  /managedvirtualnetworks/{managedVirtualNetworkName}
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_GetPrivateEndpoint (new)
Description :  Gets a ManagedPrivateEndpoint
Reference :  Link ¶

⚼ Request

GET:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The Managed PrivateEndpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_DeletePrivateEndpoint (new)
Description :  Deletes a ManagedPrivateEndpoint
Reference :  Link ¶

⚼ Request

DELETE:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The Managed PrivateEndpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_CreateOrReplacePrivateEndpoint (new)
Description :  Create or replace a ManagedPrivateEndpoint
Reference :  Link ¶

⚼ Request

PUT:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The Managed PrivateEndpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_ListByAccount (new)
Description :  Gets a list of ManagedVirtualNetworks
Reference :  Link ¶

⚼ Request

GET:  /managedvirtualnetworks
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
properties:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ManagedVirtualNetworks_ListPrivateEndpointsByAccount (new)
Description :  Gets a list of ManagedPrivateEndpoints for a given account
Reference :  Link ¶

⚼ Request

GET:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints
{
managedVirtualNetworkName:
{
Description: The Managed VirtualNetwork name. It is restricted to the value 'default' for now. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
properties:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Scans_CreateOrUpdate (new)
Description :  Creates an instance of a scan
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (201)

{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Scans_Get (new)
Description :  Gets a scan information
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans/{scanName}
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Scans_Delete (new)
Description :  Deletes the scan associated with the data source
Reference :  Link ¶

⚼ Request

DELETE:  /datasources/{dataSourceName}/scans/{scanName}
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Scans_ListByDataSource (new)
Description :  List scans in data source
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans
{
dataSourceName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
AzureSubscriptionCredential: No description available. ,
AzureSubscriptionMsi: No description available. ,
AzureResourceGroupCredential: No description available. ,
AzureResourceGroupMsi: No description available. ,
AzureSynapseWorkspaceCredential: No description available. ,
AzureSynapseWorkspaceMsi: No description available. ,
AzureSynapseCredential: No description available. ,
AzureSynapseMsi: No description available. ,
AdlsGen1Credential: No description available. ,
AdlsGen1Msi: No description available. ,
AdlsGen2Credential: No description available. ,
AdlsGen2Msi: No description available. ,
AmazonAccountCredential: No description available. ,
AmazonS3Credential: No description available. ,
AmazonS3RoleARN: No description available. ,
AmazonSqlCredential: No description available. ,
AzureCosmosDbCredential: No description available. ,
AzureDataExplorerCredential: No description available. ,
AzureDataExplorerMsi: No description available. ,
AzureFileServiceCredential: No description available. ,
AzureSqlDatabaseCredential: No description available. ,
AzureSqlDatabaseMsi: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
AzureStorageCredential: No description available. ,
AzureStorageMsi: No description available. ,
TeradataTeradataCredential: No description available. ,
TeradataTeradataUserPass: No description available. ,
TeradataUserPass: No description available. ,
OracleOracleCredential: No description available. ,
OracleOracleUserPass: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIMsi: No description available. ,
}
,
Required: True ,
}
enum ,
scanResults:
{
Required: False ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanResult_RunScan (new)
Description :  Runs the scan
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}/runs/{runId}
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
runId:
{
Required: True ,
}
string ,
scanLevel:
{
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
scanResultId:
{
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
status:
{
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanResult_CancelScan (new)
Description :  Cancels a scan
Reference :  Link ¶

⚼ Request

POST:  /datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
runId:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
scanResultId:
{
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
status:
{
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanResult_ListScanHistory (new)
Description :  Lists the scan history of a scan
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans/{scanName}/runs
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
parentId:
{
Required: False ,
}
string ,
id:
{
Required: False ,
}
string ,
resourceId:
{
Required: False ,
}
string ,
status:
{
Required: False ,
}
string ,
assetsDiscovered:
{
Format: int64 ,
Required: False ,
}
integer ,
assetsClassified:
{
Format: int64 ,
Required: False ,
}
integer ,
diagnostics:
{
Required: False ,
}
string ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
queuedTime:
{
Format: date-time ,
Required: False ,
}
string ,
pipelineStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Enum:
{
Custom: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Enum:
{
Full: No description available. ,
Incremental: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
runType:
{
Required: False ,
}
string ,
dataSourceType:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanRulesets_Get (new)
Description :  Get a scan ruleset
Reference :  Link ¶

⚼ Request

GET:  /scanrulesets/{scanRulesetName}
{
scanRulesetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanRulesets_CreateOrUpdate (new)
Description :  Creates or Updates a scan ruleset
Reference :  Link ¶

⚼ Request

PUT:  /scanrulesets/{scanRulesetName}
{
scanRulesetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanRulesets_Delete (new)
Description :  Deletes a scan ruleset
Reference :  Link ¶

⚼ Request

DELETE:  /scanrulesets/{scanRulesetName}
{
scanRulesetName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
ScanRulesets_ListAll (new)
Description :  List scan rulesets in Data catalog
Reference :  Link ¶

⚼ Request

GET:  /scanrulesets
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
SystemScanRulesets_ListAll (new)
Description :  List all system scan rulesets for an account
Reference :  Link ¶

⚼ Request

GET:  /systemScanRulesets
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
SystemScanRulesets_Get (new)
Description :  Get a system scan ruleset for a data source
Reference :  Link ¶

⚼ Request

GET:  /systemScanRulesets/datasources/{dataSourceType}
{
dataSourceType:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
SystemScanRulesets_GetByVersion (new)
Description :  Get a scan ruleset by version
Reference :  Link ¶

⚼ Request

GET:  /systemScanRulesets/versions/{version}
{
dataSourceType:
{
Required: False ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
SystemScanRulesets_GetLatest (new)
Description :  Get the latest version of a system scan ruleset
Reference :  Link ¶

⚼ Request

GET:  /systemScanRulesets/versions/latest
{
dataSourceType:
{
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
SystemScanRulesets_ListVersionsByDataSource (new)
Description :  List system scan ruleset versions in Data catalog
Reference :  Link ¶

⚼ Request

GET:  /systemScanRulesets/versions
{
dataSourceType:
{
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
kind:
{
Enum:
{
None: No description available. ,
AzureSubscription: No description available. ,
AzureResourceGroup: No description available. ,
AzureSynapseWorkspace: No description available. ,
AzureSynapse: No description available. ,
AdlsGen1: No description available. ,
AdlsGen2: No description available. ,
AmazonAccount: No description available. ,
AmazonS3: No description available. ,
AmazonSql: No description available. ,
AzureCosmosDb: No description available. ,
AzureDataExplorer: No description available. ,
AzureFileService: No description available. ,
AzureSqlDatabase: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
PowerBI: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Triggers_GetTrigger (new)
Description :  Gets trigger information
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Triggers_CreateTrigger (new)
Description :  Creates an instance of a trigger
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}
Triggers_DeleteTrigger (new)
Description :  Deletes the trigger associated with the scan
Reference :  Link ¶

⚼ Request

DELETE:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default
{
dataSourceName:
{
Required: True ,
}
string ,
scanName:
{
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
string ,
}