DataSourcesOperations Class
DataSourcesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectDataSourcesOperations
Constructor
DataSourcesOperations(client, config, serializer, deserializer)Parameters
- client
Required
Client for service requests.
- config
Required
Configuration of service client.
- serializer
Required
An object model serializer.
- deserializer
Required
An object model deserializer.
Methods
| create_or_update |
Creates or Updates a data source. |
| delete |
Deletes a data source. |
| get |
Get a data source. |
| list_all |
List data sources in Data catalog. |
create_or_update
Creates or Updates a data source.
create_or_update(data_source_name: str, body: Any = None, **kwargs: Any) -> AnyParameters
- data_source_name
- str
Required
- body
- <xref:Any>
Required
Returns
JSON object
Return type
<xref:Any>
Exceptions
Examples
kind = 'AdlsGen1DataSource' or 'AdlsGen2DataSource' or 'AmazonAccountDataSource' or 'AmazonPostgreSqlDataSource' or 'AmazonS3DataSource' or 'AmazonSqlDataSource' or 'AzureCosmosDbDataSource' or 'AzureDataExplorerDataSource' or 'AzureFileServiceDataSource' or 'AzureMySqlDataSource' or 'AzurePostgreSqlDataSource' or 'AzureResourceGroupDataSource' or 'AzureSqlDataWarehouseDataSource' or 'AzureSqlDatabaseDataSource' or 'AzureSqlDatabaseManagedInstanceDataSource' or 'AzureStorageDataSource' or 'AzureSubscriptionDataSource' or 'AzureSynapseDataSource' or 'AzureSynapseWorkspaceDataSource' or 'OracleDataSource' or 'PowerBIDataSource' or 'SapEccDataSource' or 'SapS4HanaDataSource' or 'SqlServerDatabaseDataSource' or 'TeradataDataSource'
# JSON input template you can fill out and use as your body input.
body = {
"id": "str", # Optional.
"name": "str", # Optional.
"scans": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scanResults": [
{
"assetsClassified": 0.0, # Optional.
"assetsDiscovered": 0.0, # Optional.
"dataSourceType": "str", # Optional. Possible values include: "None", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "AmazonPostgreSql", "AzurePostgreSql", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "AzureStorage", "Teradata", "Oracle", "SapS4Hana", "SapEcc", "PowerBI".
"diagnostics": {
"exceptionCountMap": {
"str": 0 # Optional. Dictionary of :code:`<integer>`.
},
"notifications": [
{
"code": 0, # Optional.
"message": "str" # Optional.
}
]
},
"endTime": "2020-02-20 00:00:00", # Optional.
"error": {
"code": "str", # Optional.
"details": [
{
"code": "str", # Optional.
"details": [
...
],
"message": "str", # Optional.
"target": "str" # Optional.
}
],
"message": "str", # Optional.
"target": "str" # Optional.
},
"errorMessage": "str", # Optional.
"id": "str", # Optional.
"parentId": "str", # Optional.
"pipelineStartTime": "2020-02-20 00:00:00", # Optional.
"queuedTime": "2020-02-20 00:00:00", # Optional.
"resourceId": "str", # Optional.
"runType": "str", # Optional.
"scanLevelType": "str", # Optional. Possible values include: "Full", "Incremental".
"scanRulesetType": "str", # Optional. Possible values include: "Custom", "System".
"scanRulesetVersion": 0, # Optional.
"startTime": "2020-02-20 00:00:00", # Optional.
"status": "str" # Optional.
}
],
kind: Scan
}
],
kind: DataSource
}
# response body for status code(s): 200, 201
response.json() == {
"id": "str", # Optional.
"name": "str", # Optional.
"scans": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scanResults": [
{
"assetsClassified": 0.0, # Optional.
"assetsDiscovered": 0.0, # Optional.
"dataSourceType": "str", # Optional. Possible values include: "None", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "AmazonPostgreSql", "AzurePostgreSql", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "AzureStorage", "Teradata", "Oracle", "SapS4Hana", "SapEcc", "PowerBI".
"diagnostics": {
"exceptionCountMap": {
"str": 0 # Optional. Dictionary of :code:`<integer>`.
},
"notifications": [
{
"code": 0, # Optional.
"message": "str" # Optional.
}
]
},
"endTime": "2020-02-20 00:00:00", # Optional.
"error": {
"code": "str", # Optional.
"details": [
{
"code": "str", # Optional.
"details": [
...
],
"message": "str", # Optional.
"target": "str" # Optional.
}
],
"message": "str", # Optional.
"target": "str" # Optional.
},
"errorMessage": "str", # Optional.
"id": "str", # Optional.
"parentId": "str", # Optional.
"pipelineStartTime": "2020-02-20 00:00:00", # Optional.
"queuedTime": "2020-02-20 00:00:00", # Optional.
"resourceId": "str", # Optional.
"runType": "str", # Optional.
"scanLevelType": "str", # Optional. Possible values include: "Full", "Incremental".
"scanRulesetType": "str", # Optional. Possible values include: "Custom", "System".
"scanRulesetVersion": 0, # Optional.
"startTime": "2020-02-20 00:00:00", # Optional.
"status": "str" # Optional.
}
],
kind: Scan
}
],
kind: DataSource
}
delete
Deletes a data source.
delete(data_source_name: str, **kwargs: Any) -> Optional[Any]Parameters
- data_source_name
- str
Required
Returns
JSON object
Return type
<xref:Any>,
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"id": "str", # Optional.
"name": "str", # Optional.
"scans": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scanResults": [
{
"assetsClassified": 0.0, # Optional.
"assetsDiscovered": 0.0, # Optional.
"dataSourceType": "str", # Optional. Possible values include: "None", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "AmazonPostgreSql", "AzurePostgreSql", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "AzureStorage", "Teradata", "Oracle", "SapS4Hana", "SapEcc", "PowerBI".
"diagnostics": {
"exceptionCountMap": {
"str": 0 # Optional. Dictionary of :code:`<integer>`.
},
"notifications": [
{
"code": 0, # Optional.
"message": "str" # Optional.
}
]
},
"endTime": "2020-02-20 00:00:00", # Optional.
"error": {
"code": "str", # Optional.
"details": [
{
"code": "str", # Optional.
"details": [
...
],
"message": "str", # Optional.
"target": "str" # Optional.
}
],
"message": "str", # Optional.
"target": "str" # Optional.
},
"errorMessage": "str", # Optional.
"id": "str", # Optional.
"parentId": "str", # Optional.
"pipelineStartTime": "2020-02-20 00:00:00", # Optional.
"queuedTime": "2020-02-20 00:00:00", # Optional.
"resourceId": "str", # Optional.
"runType": "str", # Optional.
"scanLevelType": "str", # Optional. Possible values include: "Full", "Incremental".
"scanRulesetType": "str", # Optional. Possible values include: "Custom", "System".
"scanRulesetVersion": 0, # Optional.
"startTime": "2020-02-20 00:00:00", # Optional.
"status": "str" # Optional.
}
],
kind: Scan
}
],
kind: DataSource
}
get
Get a data source.
get(data_source_name: str, **kwargs: Any) -> AnyParameters
- data_source_name
- str
Required
Returns
JSON object
Return type
<xref:Any>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"id": "str", # Optional.
"name": "str", # Optional.
"scans": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scanResults": [
{
"assetsClassified": 0.0, # Optional.
"assetsDiscovered": 0.0, # Optional.
"dataSourceType": "str", # Optional. Possible values include: "None", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "AmazonPostgreSql", "AzurePostgreSql", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "AzureStorage", "Teradata", "Oracle", "SapS4Hana", "SapEcc", "PowerBI".
"diagnostics": {
"exceptionCountMap": {
"str": 0 # Optional. Dictionary of :code:`<integer>`.
},
"notifications": [
{
"code": 0, # Optional.
"message": "str" # Optional.
}
]
},
"endTime": "2020-02-20 00:00:00", # Optional.
"error": {
"code": "str", # Optional.
"details": [
{
"code": "str", # Optional.
"details": [
...
],
"message": "str", # Optional.
"target": "str" # Optional.
}
],
"message": "str", # Optional.
"target": "str" # Optional.
},
"errorMessage": "str", # Optional.
"id": "str", # Optional.
"parentId": "str", # Optional.
"pipelineStartTime": "2020-02-20 00:00:00", # Optional.
"queuedTime": "2020-02-20 00:00:00", # Optional.
"resourceId": "str", # Optional.
"runType": "str", # Optional.
"scanLevelType": "str", # Optional. Possible values include: "Full", "Incremental".
"scanRulesetType": "str", # Optional. Possible values include: "Custom", "System".
"scanRulesetVersion": 0, # Optional.
"startTime": "2020-02-20 00:00:00", # Optional.
"status": "str" # Optional.
}
],
kind: Scan
}
],
kind: DataSource
}
list_all
List data sources in Data catalog.
list_all(**kwargs: Any) -> Iterable[Any]Returns
An iterator like instance of JSON object
Return type
ItemPaged[<xref:Any>]
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"count": 0.0, # Optional.
"nextLink": "str", # Optional.
"value": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scans": [
{
"id": "str", # Optional.
"name": "str", # Optional.
"scanResults": [
{
"assetsClassified": 0.0, # Optional.
"assetsDiscovered": 0.0, # Optional.
"dataSourceType": "str", # Optional. Possible values include: "None", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "AmazonPostgreSql", "AzurePostgreSql", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "AzureStorage", "Teradata", "Oracle", "SapS4Hana", "SapEcc", "PowerBI".
"diagnostics": {
"exceptionCountMap": {
"str": 0 # Optional. Dictionary of :code:`<integer>`.
},
"notifications": [
{
"code": 0, # Optional.
"message": "str" # Optional.
}
]
},
"endTime": "2020-02-20 00:00:00", # Optional.
"error": {
"code": "str", # Optional.
"details": [
{
"code": "str", # Optional.
"details": [
...
],
"message": "str", # Optional.
"target": "str" # Optional.
}
],
"message": "str", # Optional.
"target": "str" # Optional.
},
"errorMessage": "str", # Optional.
"id": "str", # Optional.
"parentId": "str", # Optional.
"pipelineStartTime": "2020-02-20 00:00:00", # Optional.
"queuedTime": "2020-02-20 00:00:00", # Optional.
"resourceId": "str", # Optional.
"runType": "str", # Optional.
"scanLevelType": "str", # Optional. Possible values include: "Full", "Incremental".
"scanRulesetType": "str", # Optional. Possible values include: "Custom", "System".
"scanRulesetVersion": 0, # Optional.
"startTime": "2020-02-20 00:00:00", # Optional.
"status": "str" # Optional.
}
],
kind: Scan
}
],
kind: DataSource
}
]
}
Feedback
Submit and view feedback for