MicrosoftScanningClient (stable:2023-09-01)

2025/12/05 • 58 new methods

KeyVaultConnections_Get (new)
Description :  Gets an Azure Key Vault connection.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Azure Key Vault connection properties. ,
Required: False ,
}
{
baseUrl:
{
Description: The base URL of the Azure Key Vault. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Azure Key Vault connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
KeyVaultConnections_CreateOrReplace (new)
Description :  Creates or replaces a connection to Azure Key Vault.
Reference :  Link ¶

⚼ Request

PUT:  /azureKeyVaults/{azureKeyVaultName}
{
azureKeyVaultName:
{
Description: The Azure Key Vault name. ,
Required: True ,
}
string ,
body:
{
Description: The Azure Key Vault connection definition. ,
Required: True ,
}
{
properties:
{
Description: Azure Key Vault connection properties. ,
Required: False ,
}
{
baseUrl:
{
Description: The base URL of the Azure Key Vault. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Azure Key Vault connection. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Azure Key Vault connection properties. ,
Required: False ,
}
{
baseUrl:
{
Description: The base URL of the Azure Key Vault. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Azure Key Vault connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Azure Key Vault connection properties. ,
Required: False ,
}
{
baseUrl:
{
Description: The base URL of the Azure Key Vault. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Azure Key Vault connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
KeyVaultConnections_Delete (new)
Description :  Deletes an Azure Key Vault connection associated with the account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
KeyVaultConnections_List (new)
Description :  Lists Azure Key Vaults in an account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Azure Key Vault connections. ,
Required: True ,
}
[
{
properties:
{
Description: Azure Key Vault connection properties. ,
Required: False ,
}
{
baseUrl:
{
Description: The base URL of the Azure Key Vault. ,
Required: False ,
}
string ,
description:
{
Description: The description of the Azure Key Vault connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Format: uri ,
Required: False ,
}
string ,
count:
{
Description: The number of Azure Key Vault connections. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ClassificationRules_Get (new)
Description :  Gets a classification rule.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ClassificationRules_CreateOrReplace (new)
Description :  Creates or replaces a classification rule.
Reference :  Link ¶

⚼ Request

PUT:  /classificationrules/{classificationRuleName}
{
classificationRuleName:
{
Description: The classification rule name. ,
Required: True ,
}
string ,
body:
{
Description: The classification rule definition. ,
Required: True ,
}
{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ClassificationRules_Delete (new)
Description :  Deletes a classification rule.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ClassificationRules_List (new)
Description :  Lists classification rules in Account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of classification rules. ,
Required: True ,
}
[
{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of classification rules. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ClassificationRules_ListVersionsByRuleName (new)
Description :  Lists the rule versions of a classification rule.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of classification rules. ,
Required: True ,
}
[
{
kind:
{
Description: The kind of classification rule. ,
Enum:
{
System: the classification rule is using system default ,
Custom: the classification rule is custom rule ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of classification rules. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
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:
{
Description: The classification rule name. ,
Required: True ,
}
string ,
classificationRuleVersion:
{
Description: The version of the classification rule. ,
Format: int32 ,
Required: True ,
}
integer ,
action:
{
Description: The action of classification rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Response header for long running operation. ,
}
string ,
}
,
$schema:
{
Description: The operation response. ,
}
{
scanResultId:
{
Description: The scan result identifier. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Scan operation status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error info. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: False ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: Error info detail. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Credential_Get (new)
Description :  Gets credential information.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The kind of credential. ,
Enum:
{
AccountKey: the credential type is account key ,
ServicePrincipal: the credential type is service principal ,
BasicAuth: the credential type is basic auth ,
SqlAuth: the credential type is sql auth ,
AmazonARN: the credential type is amazon ARN ,
ConsumerKeyAuth: the credential type is Consumer Key Auth ,
DelegatedAuth: the credential type is delegated auth ,
ManagedIdentity: the credential type is managed identity ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Credential_CreateOrReplace (new)
Description :  Creates or replaces an instance of a credential.
Reference :  Link ¶

⚼ Request

PUT:  /credentials/{credentialName}
{
credentialName:
{
Description: The credential name. ,
Required: True ,
}
string ,
body:
{
Description: The credential definition. ,
Required: True ,
}
{
kind:
{
Description: The kind of credential. ,
Enum:
{
AccountKey: the credential type is account key ,
ServicePrincipal: the credential type is service principal ,
BasicAuth: the credential type is basic auth ,
SqlAuth: the credential type is sql auth ,
AmazonARN: the credential type is amazon ARN ,
ConsumerKeyAuth: the credential type is Consumer Key Auth ,
DelegatedAuth: the credential type is delegated auth ,
ManagedIdentity: the credential type is managed identity ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The kind of credential. ,
Enum:
{
AccountKey: the credential type is account key ,
ServicePrincipal: the credential type is service principal ,
BasicAuth: the credential type is basic auth ,
SqlAuth: the credential type is sql auth ,
AmazonARN: the credential type is amazon ARN ,
ConsumerKeyAuth: the credential type is Consumer Key Auth ,
DelegatedAuth: the credential type is delegated auth ,
ManagedIdentity: the credential type is managed identity ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The kind of credential. ,
Enum:
{
AccountKey: the credential type is account key ,
ServicePrincipal: the credential type is service principal ,
BasicAuth: the credential type is basic auth ,
SqlAuth: the credential type is sql auth ,
AmazonARN: the credential type is amazon ARN ,
ConsumerKeyAuth: the credential type is Consumer Key Auth ,
DelegatedAuth: the credential type is delegated auth ,
ManagedIdentity: the credential type is managed identity ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Credential_Delete (new)
Description :  Deletes a credential associated with the account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Credential_List (new)
Description :  Lists credentials in account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of credentials. ,
Required: True ,
}
[
{
kind:
{
Description: The kind of credential. ,
Enum:
{
AccountKey: the credential type is account key ,
ServicePrincipal: the credential type is service principal ,
BasicAuth: the credential type is basic auth ,
SqlAuth: the credential type is sql auth ,
AmazonARN: the credential type is amazon ARN ,
ConsumerKeyAuth: the credential type is Consumer Key Auth ,
DelegatedAuth: the credential type is delegated auth ,
ManagedIdentity: the credential type is managed identity ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of credentials. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
DataSources_CreateOrReplace (new)
Description :  Creates or replaces a data source.
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
body:
{
Description: The data source definition. ,
Required: True ,
}
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Description: Scans of this data source. ,
Required: False ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Description: Scans of this data source. ,
Required: False ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Description: Scans of this data source. ,
Required: False ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
DataSources_Get (new)
Description :  Gets a data source.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Description: Scans of this data source. ,
Required: False ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
DataSources_Delete (new)
Description :  Deletes a data source.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
DataSources_List (new)
Description :  Lists data sources in Data catalog.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of data sources. ,
Required: True ,
}
[
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
scans:
{
Description: Scans of this data source. ,
Required: False ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of data sources. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Filters_Get (new)
Description :  Gets a filter.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The filter properties. ,
Required: False ,
}
{
excludeUriPrefixes:
{
Description: The exclude uri prefixes. ,
Required: True ,
}
[
string ,
]
,
includeUriPrefixes:
{
Description: The include uri prefixes. ,
Required: True ,
}
[
string ,
]
,
excludeRegexes:
{
Description: The exclude regexes. ,
Required: False ,
}
[
string ,
]
,
includeRegexes:
{
Description: The include regexes. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Filters_CreateOrReplace (new)
Description :  Creates or replaces a filter.
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}/filters/custom
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
body:
{
Description: The filter definition. ,
Required: True ,
}
{
properties:
{
Description: The filter properties. ,
Required: False ,
}
{
excludeUriPrefixes:
{
Description: The exclude uri prefixes. ,
Required: True ,
}
[
string ,
]
,
includeUriPrefixes:
{
Description: The include uri prefixes. ,
Required: True ,
}
[
string ,
]
,
excludeRegexes:
{
Description: The exclude regexes. ,
Required: False ,
}
[
string ,
]
,
includeRegexes:
{
Description: The include regexes. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The filter properties. ,
Required: False ,
}
{
excludeUriPrefixes:
{
Description: The exclude uri prefixes. ,
Required: True ,
}
[
string ,
]
,
includeUriPrefixes:
{
Description: The include uri prefixes. ,
Required: True ,
}
[
string ,
]
,
excludeRegexes:
{
Description: The exclude regexes. ,
Required: False ,
}
[
string ,
]
,
includeRegexes:
{
Description: The include regexes. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The filter properties. ,
Required: False ,
}
{
excludeUriPrefixes:
{
Description: The exclude uri prefixes. ,
Required: True ,
}
[
string ,
]
,
includeUriPrefixes:
{
Description: The include uri prefixes. ,
Required: True ,
}
[
string ,
]
,
excludeRegexes:
{
Description: The exclude regexes. ,
Required: False ,
}
[
string ,
]
,
includeRegexes:
{
Description: The include regexes. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_ListByAccount (new)
Description :  Lists integration runtimes in an account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of integration runtimes. ,
Required: True ,
}
[
{
kind:
{
Description: The type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of integration runtimes. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_Get (new)
Description :  Gets an integration runtime.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_Delete (new)
Description :  Deletes an integration runtime.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_CreateOrReplace (new)
Description :  Creates or replaces an instance of integration runtime.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_Status (new)
Description :  Gets detailed status information for an integration runtime.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The type of integration runtime. ,
Enum:
{
Managed: No description available. ,
SelfHosted: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_ListAuthKeys (new)
Description :  Retrieves the authentication keys for an integration runtime.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_RegenerateAuthKey (new)
Description :  Regenerates the authentication key for an integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}:regenerateAuthKey
{
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
body:
{
Description: The request of regenerating authentication key of an integration runtime. ,
Required: True ,
}
{
keyName:
{
Description: The name of the authentication key to regenerate. ,
Enum:
{
authKey1: No description available. ,
authKey2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authKey1:
{
Description: The primary integration runtime authentication key. ,
Required: False ,
}
string ,
authKey2:
{
Description: The secondary integration runtime authentication key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_DisableInteractiveQuery (new)
Description :  Disables interactive querying.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Response header for long running operation. ,
}
string ,
}
,
$schema:
{
Description: The operation response. ,
}
{
scanResultId:
{
Description: The scan result identifier. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Scan operation status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error info. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: False ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: Error info detail. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
IntegrationRuntimes_EnableInteractiveQuery (new)
Description :  Enables interactive querying.
Reference :  Link ¶

⚼ Request

POST:  /integrationruntimes/{integrationRuntimeName}:enableInteractiveQuery
{
integrationRuntimeName:
{
Description: The integration runtime name. ,
Required: True ,
}
string ,
body:
{
Description: The request of enabling interactive query for integration runtime. ,
Required: True ,
}
{
autoTerminationMinutes:
{
Description: The interactive querying auto termination time in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Response header for long running operation. ,
}
string ,
}
,
$schema:
{
Description: The operation response. ,
}
{
scanResultId:
{
Description: The scan result identifier. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Scan operation status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error info. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: False ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: Error info detail. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedVirtualNetworks_ListByAccount (new)
Description :  Lists managed virtual networks in an account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of managed virtual networks. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of managed virtual network. ,
Required: False ,
}
{
vNetId:
{
Description: The ID of the VNet that this integration runtime will join. ,
Required: False ,
}
string ,
alias:
{
Description: The alias of managed virtual network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of managed virtual networks. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedVirtualNetworks_Get (new)
Description :  Gets a managed virtual network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of managed virtual network. ,
Required: False ,
}
{
vNetId:
{
Description: The ID of the VNet that this integration runtime will join. ,
Required: False ,
}
string ,
alias:
{
Description: The alias of managed virtual network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedVirtualNetworks_CreateOrReplace (new)
Description :  Creates or replaces a managed virtual network.
Reference :  Link ¶

⚼ Request

PUT:  /managedvirtualnetworks/{managedVirtualNetworkName}
{
managedVirtualNetworkName:
{
Description: The managed virtual network name. It is restricted to the value 'defaultv2' for now. ,
Required: True ,
}
string ,
body:
{
Description: The managed virtual network resource definition. ,
Required: True ,
}
{
properties:
{
Description: The properties of managed virtual network. ,
Required: False ,
}
{
vNetId:
{
Description: The ID of the VNet that this integration runtime will join. ,
Required: False ,
}
string ,
alias:
{
Description: The alias of managed virtual network. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of managed virtual network. ,
Required: False ,
}
{
vNetId:
{
Description: The ID of the VNet that this integration runtime will join. ,
Required: False ,
}
string ,
alias:
{
Description: The alias of managed virtual network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of managed virtual network. ,
Required: False ,
}
{
vNetId:
{
Description: The ID of the VNet that this integration runtime will join. ,
Required: False ,
}
string ,
alias:
{
Description: The alias of managed virtual network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedPrivateEndpoints_ListByAccount (new)
Description :  Lists managed private endpoints under a managed virtual network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of managed private endpoints. ,
Required: True ,
}
[
{
properties:
{
Description: The properties of managed private endpoint. ,
Required: False ,
}
{
connectionState:
{
Description: The properties of connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: ActionsRequired for a private link connection. ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection. ,
Required: False ,
}
string ,
status:
{
Description: Status of a private link connection. ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: The fqdns of managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The group identifier of managed private endpoint. ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The private link resource identifier of managed private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of managed private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of managed private endpoints. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedPrivateEndpoints_Get (new)
Description :  Gets a managed private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The managed virtual network name. It is restricted to the value 'defaultv2' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of managed private endpoint. ,
Required: False ,
}
{
connectionState:
{
Description: The properties of connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: ActionsRequired for a private link connection. ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection. ,
Required: False ,
}
string ,
status:
{
Description: Status of a private link connection. ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: The fqdns of managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The group identifier of managed private endpoint. ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The private link resource identifier of managed private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of managed private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedPrivateEndpoints_Delete (new)
Description :  Deletes a managed private endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The managed virtual network name. It is restricted to the value 'defaultv2' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedPrivateEndpoints_CreateOrReplace (new)
Description :  Creates or replaces a managed private endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}
{
managedVirtualNetworkName:
{
Description: The managed virtual network name. It is restricted to the value 'defaultv2' for now. ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: The managed private endpoint name. ,
Required: True ,
}
string ,
body:
{
Description: The managed private endpoint resource definition. ,
Required: True ,
}
{
properties:
{
Description: The properties of managed private endpoint. ,
Required: False ,
}
{
connectionState:
{
Description: The properties of connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: ActionsRequired for a private link connection. ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection. ,
Required: False ,
}
string ,
status:
{
Description: Status of a private link connection. ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: The fqdns of managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The group identifier of managed private endpoint. ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The private link resource identifier of managed private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of managed private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of managed private endpoint. ,
Required: False ,
}
{
connectionState:
{
Description: The properties of connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: ActionsRequired for a private link connection. ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection. ,
Required: False ,
}
string ,
status:
{
Description: Status of a private link connection. ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: The fqdns of managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The group identifier of managed private endpoint. ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The private link resource identifier of managed private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of managed private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of managed private endpoint. ,
Required: False ,
}
{
connectionState:
{
Description: The properties of connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: ActionsRequired for a private link connection. ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection. ,
Required: False ,
}
string ,
status:
{
Description: Status of a private link connection. ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: The fqdns of managed private endpoint. ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The group identifier of managed private endpoint. ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The private link resource identifier of managed private endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of managed private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Scans_CreateOrReplace (new)
Description :  Creates or replaces an instance of a scan.
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
body:
{
Description: The scan definition. ,
Required: True ,
}
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Scans_Get (new)
Description :  Gets a scan information.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Scans_Delete (new)
Description :  Deletes the scan associated with the data source.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Scans_ListByDataSource (new)
Description :  Lists scans in data source.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of scans. ,
Required: True ,
}
[
{
kind:
{
Description: The properties of scan, vary by datasource type. ,
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. ,
AzureSqlDatabaseNativeAuth: No description available. ,
ArcEnabledSqlServerCredential: No description available. ,
ArcEnabledSqlServerNativeAuth: No description available. ,
AmazonPostgreSqlCredential: No description available. ,
AzurePostgreSqlCredential: No description available. ,
DatabricksCredential: No description available. ,
SqlServerDatabaseCredential: No description available. ,
AzureSqlDatabaseManagedInstanceCredential: No description available. ,
AzureSqlDatabaseManagedInstanceMsi: No description available. ,
AzureSqlDatabaseManagedInstanceNativeAuth: No description available. ,
AzureSqlDataWarehouseCredential: No description available. ,
AzureSqlDataWarehouseMsi: No description available. ,
AzureMySqlCredential: No description available. ,
HdfsCredential: 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. ,
DatabricksHmsCredential: No description available. ,
SapS4HanaSapS4HanaCredential: No description available. ,
SapS4HanaSapS4HanaUserPass: No description available. ,
SapEccSapEccCredential: No description available. ,
SapEccSapEccUserPass: No description available. ,
SnowflakeCredential: No description available. ,
PowerBICredential: No description available. ,
PowerBIDelegated: No description available. ,
PowerBIFpa: No description available. ,
PowerBIMsi: No description available. ,
FabricCredential: No description available. ,
FabricDelegated: No description available. ,
FabricFpa: No description available. ,
FabricMsi: No description available. ,
TridentCredential: No description available. ,
TridentDelegated: No description available. ,
TridentMsi: No description available. ,
DataverseCredential: No description available. ,
DataverseMsi: No description available. ,
}
,
Required: True ,
}
enum ,
lastRunResult:
{
Description: The scan result with ingestion. ,
Required: False ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scanId:
{
Description: The scan identifier. ,
Required: False ,
}
string ,
dataSourceIdentifier:
{
Description: The data source identifier. ,
Required: False ,
}
{
itemPath:
{
Description: The item path. ,
Required: False ,
}
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
qualifiedName:
{
Description: The qualified name. ,
Required: False ,
}
{
typeName:
{
Description: The type name. ,
Required: False ,
}
string ,
name:
{
Description: The name. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: The extended properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: False ,
}
string ,
}
,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
guid:
{
Description: The guid. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
dataSourceName:
{
Description: The data source name. ,
Required: False ,
}
string ,
creationType:
{
Description: The creation type. ,
Enum:
{
Manual: the datasource creation type is Manual ,
AutoNative: the datasource creation type is auto created, native ,
AutoManaged: the datasource creation type is auto managed ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of scans. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanResult_GetScanStatus (new)
Description :  Gets the status of the scan run with ingestion details.
Reference :  Link ¶

⚼ Request

GET:  /datasources/{dataSourceName}/scans/{scanName}/runs/{runId}
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
runId:
{
Description: The scan run id. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanResult_RunScan (new)
Description :  Runs the scan
Reference :  Link ¶

⚼ Request

POST:  /datasources/{dataSourceName}/scans/{scanName}:run
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
runId:
{
Description: The scan run id. ,
Required: True ,
}
string ,
scanLevel:
{
Description: The scan level. ,
Required: False ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Response header for long running operation. ,
}
string ,
}
,
$schema:
{
Description: The scan result with ingestion. ,
}
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ScanResult_CancelScan (new)
Description :  Cancels a scan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Response header for long running operation. ,
}
string ,
}
,
$schema:
{
Description: The operation response. ,
}
{
scanResultId:
{
Description: The scan result identifier. ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Scan operation status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error info. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: False ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: Error info detail. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanResult_ListScanHistory (new)
Description :  Lists the scan history of a scan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of scan history with ingestion. ,
Required: True ,
}
[
{
discoveryExecutionDetails:
{
Description: The discovery execution details. ,
Required: False ,
}
{
discoveryStartTime:
{
Description: The discovery start time. ,
Format: date-time ,
Required: False ,
}
string ,
discoveryEndTime:
{
Description: The discovery end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The discovery status. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Delayed: No description available. ,
Throttled: No description available. ,
CompletedWithExceptions: No description available. ,
CompleteWithWarning: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The discovery statistics. ,
Required: False ,
}
object ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
}
,
ingestionExecutionDetails:
{
Description: The ingestion execution details. ,
Required: False ,
}
{
ingestionStartTime:
{
Description: The ingestion start time. ,
Format: date-time ,
Required: False ,
}
string ,
ingestionEndTime:
{
Description: The ingestion end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The ingestion status. ,
Enum:
{
None: No description available. ,
Succeeded: No description available. ,
Queued: No description available. ,
InProgress: No description available. ,
SourceUnknown: No description available. ,
PartialSucceeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Canceling: No description available. ,
}
,
Required: False ,
}
enum ,
statistics:
{
Description: The ingestion statistics. ,
Required: False ,
}
object ,
estimatedTimeRemainingInSeconds:
{
Description: The estimated time remaining in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
isErrorLogAvailable:
{
Description: Indicates whether the error log is available. ,
Required: False ,
}
boolean ,
lastUpdatedAt:
{
Description: The last updated time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parentId:
{
Description: The parent scan result identifier. ,
Required: False ,
}
string ,
id:
{
Description: The scan result identifier. ,
Required: False ,
}
string ,
ingestionJobId:
{
Description: The ingestion job identifier. ,
Required: False ,
}
string ,
resourceId:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
status:
{
Description: The scan result status. ,
Enum:
{
Accepted: the scan is accepted ,
InProgress: the scan is InProgress ,
TransientFailure: the scan is in transient failure ,
Succeeded: the scan is succeeded ,
Failed: the scan is failed ,
Canceled: the scan is canceled ,
}
,
Required: False ,
}
enum ,
diagnostics:
{
Description: The scan diagnostics. ,
Required: False ,
}
{
notifications:
{
Description: Notifications. ,
Required: False ,
}
[
{
message:
{
Description: Notification message. ,
Required: False ,
}
string ,
code:
{
Description: Notification code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
exceptionCountMap:
{
Description: Exception count map. ,
Required: False ,
}
object ,
}
,
startTime:
{
Description: The scan start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time. ,
Format: date-time ,
Required: False ,
}
string ,
scanRulesetVersion:
{
Description: The scan ruleset version. ,
Format: int32 ,
Required: False ,
}
integer ,
scanRulesetType:
{
Description: The scan ruleset type. ,
Enum:
{
Custom: the scan ruleset type is custom ,
System: the scan ruleset type is system default ,
}
,
Required: False ,
}
enum ,
scanLevelType:
{
Description: Scan level type. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
runType:
{
Description: The run type. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of scan history with ingestion. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanRulesets_Get (new)
Description :  Gets a scan ruleset.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanRulesets_CreateOrReplace (new)
Description :  Creates or replaces a scan ruleset.
Reference :  Link ¶

⚼ Request

PUT:  /scanrulesets/{scanRulesetName}
{
scanRulesetName:
{
Description: The scan ruleset name. ,
Required: True ,
}
string ,
body:
{
Description: The scan rule set definition. ,
Required: True ,
}
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanRulesets_Delete (new)
Description :  Deletes a scan ruleset.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ScanRulesets_List (new)
Description :  Lists scan rulesets in data catalog.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of scan rulesets. ,
Required: True ,
}
[
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of scan rulesets. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
SystemScanRulesets_List (new)
Description :  Lists 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:
{
Description: List of system scan rulesets. ,
Required: True ,
}
[
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of system scan rulesets. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
SystemScanRulesets_Get (new)
Description :  Gets a system scan ruleset for a data source.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
SystemScanRulesets_GetByVersion (new)
Description :  Gets a scan ruleset by version.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
SystemScanRulesets_GetLatest (new)
Description :  Gets the latest version of a system scan ruleset.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
SystemScanRulesets_ListVersionsByDataSource (new)
Description :  Lists system scan ruleset versions in data catalog.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of system scan rulesets. ,
Required: True ,
}
[
{
kind:
{
Description: The data source type. ,
Enum:
{
None: No description available. ,
Fabric: 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. ,
ArcEnabledSqlServer: No description available. ,
AmazonPostgreSql: No description available. ,
AzurePostgreSql: No description available. ,
Databricks: No description available. ,
SqlServerDatabase: No description available. ,
AzureSqlDatabaseManagedInstance: No description available. ,
AzureSqlDataWarehouse: No description available. ,
AzureMySql: No description available. ,
Hdfs: No description available. ,
TableauServer: No description available. ,
AzureStorage: No description available. ,
Teradata: No description available. ,
Oracle: No description available. ,
PostgreSql: No description available. ,
AmazonRedShift: No description available. ,
DatabricksHms: No description available. ,
SapS4Hana: No description available. ,
SapEcc: No description available. ,
Snowflake: No description available. ,
PowerBI: No description available. ,
Trident: No description available. ,
Dataverse: No description available. ,
DatabricksUnityCatalog: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
count:
{
Description: The number of system scan rulesets. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Triggers_Get (new)
Description :  Gets trigger information.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Triggers_CreateOrReplace (new)
Description :  Creates or replaces an instance of a trigger.
Reference :  Link ¶

⚼ Request

PUT:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
body:
{
Description: The trigger definition. ,
Required: True ,
}
{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Triggers_Delete (new)
Description :  Deletes the trigger associated with the scan.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Triggers_Enable (new)
Description :  Enables a trigger.
Reference :  Link ¶

⚼ Request

POST:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default:enable
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Triggers_Disable (new)
Description :  Disables a trigger.
Reference :  Link ¶

⚼ Request

POST:  /datasources/{dataSourceName}/scans/{scanName}/triggers/default:disable
{
dataSourceName:
{
Description: The dataSource name. ,
Required: True ,
}
string ,
scanName:
{
Description: The scan name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of trigger. ,
Required: False ,
}
{
recurrence:
{
Description: The recurrence of trigger. ,
Required: False ,
}
{
frequency:
{
Description: The frequency of trigger recurrence. ,
Enum:
{
Week: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval of trigger recurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of trigger recurrence. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule of trigger recurrence. ,
Required: False ,
}
{
minutes:
{
Description: The minutes of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The week days of recurrence schedule. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Month days of recurrence schedule. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences of recurrence schedule. ,
Required: False ,
}
[
{
day:
{
Description: The day of recurrence schedule occurrence. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
timeZone:
{
Description: The time zone of trigger recurrence. ,
Required: False ,
}
string ,
}
,
recurrenceInterval:
{
Description: The recurrence interval of trigger. ,
Required: False ,
}
string ,
createdAt:
{
Description: The create time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The last modified time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
lastScheduled:
{
Description: The last scheduled time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state of trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scanLevel:
{
Description: The scan level of trigger. ,
Enum:
{
Full: the scan is full scan ,
Incremental: the scan is incremental scan ,
}
,
Required: False ,
}
enum ,
incrementalScanStartTime:
{
Description: The incremental scan start time of trigger. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
validationErrorInfo:
{
Description: The validation error info of trigger. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The error response model. ,
}
{
error:
{
Description: The error model. ,
Required: True ,
}
{
code:
{
Description: A unique error code that identifies the specific error. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable error message that provides more details about the error. ,
Required: True ,
}
string ,
target:
{
Description: The specific component that the error is associated with. ,
Required: False ,
}
string ,
details:
{
Description: An array of nested ErrorModel objects that provides additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}