PurviewDataSourceClient.GetPropertiesAsync(RequestOptions) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Scanning

Assembly:: Azure.Analytics.Purview.Scanning.dll

Package:: Azure.Analytics.Purview.Scanning v1.0.0-beta.2

Source:: PurviewDataSourceClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get a data source.

public virtual System.Threading.Tasks.Task<Azure.Response> GetPropertiesAsync (Azure.RequestOptions options);

abstract member GetPropertiesAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.GetPropertiesAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetPropertiesAsync (options As RequestOptions) As Task(Of Response)

Parameters

options: Azure.RequestOptions

The request options.

Returns

Task<Response>

Remarks

Schema for Response Body:

{
              id: string,
              name: string,
              kind: "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",
              scans: [
                {
                  id: string,
                  name: string,
                  kind: "AzureSubscriptionCredential" | "AzureSubscriptionMsi" | "AzureResourceGroupCredential" | "AzureResourceGroupMsi" | "AzureSynapseWorkspaceCredential" | "AzureSynapseWorkspaceMsi" | "AzureSynapseCredential" | "AzureSynapseMsi" | "AdlsGen1Credential" | "AdlsGen1Msi" | "AdlsGen2Credential" | "AdlsGen2Msi" | "AmazonAccountCredential" | "AmazonS3Credential" | "AmazonS3RoleARN" | "AmazonSqlCredential" | "AzureCosmosDbCredential" | "AzureDataExplorerCredential" | "AzureDataExplorerMsi" | "AzureFileServiceCredential" | "AzureSqlDatabaseCredential" | "AzureSqlDatabaseMsi" | "AmazonPostgreSqlCredential" | "AzurePostgreSqlCredential" | "SqlServerDatabaseCredential" | "AzureSqlDatabaseManagedInstanceCredential" | "AzureSqlDatabaseManagedInstanceMsi" | "AzureSqlDataWarehouseCredential" | "AzureSqlDataWarehouseMsi" | "AzureMySqlCredential" | "AzureStorageCredential" | "AzureStorageMsi" | "TeradataTeradataCredential" | "TeradataTeradataUserPass" | "TeradataUserPass" | "OracleOracleCredential" | "OracleOracleUserPass" | "SapS4HanaSapS4HanaCredential" | "SapS4HanaSapS4HanaUserPass" | "SapEccSapEccCredential" | "SapEccSapEccUserPass" | "PowerBIDelegated" | "PowerBIMsi",
                  scanResults: [
                    {
                      parentId: string,
                      id: string,
                      resourceId: string,
                      status: string,
                      assetsDiscovered: number,
                      assetsClassified: number,
                      diagnostics: {
                        notifications: [
                          {
                            message: string,
                            code: number
                          }
                        ],
                        exceptionCountMap: Dictionary<string, number>
                      },
                      startTime: string (ISO 8601 Format),
                      queuedTime: string (ISO 8601 Format),
                      pipelineStartTime: string (ISO 8601 Format),
                      endTime: string (ISO 8601 Format),
                      scanRulesetVersion: number,
                      scanRulesetType: "Custom" | "System",
                      scanLevelType: "Full" | "Incremental",
                      errorMessage: string,
                      error: {
                        code: string,
                        message: string,
                        target: string,
                        details: [
                          {
                            code: string,
                            message: string,
                            target: string,
                            details: [ErrorModel]
                          }
                        ]
                      },
                      runType: string,
                      dataSourceType: "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"
                    }
                  ]
                }
              ]
            }

Schema for Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [
                  {
                    code: string,
                    message: string,
                    target: string,
                    details: [ErrorModel]
                  }
                ]
              }
            }

Applies to

Share via