PurviewScanningServiceClient.GetScanRuleset(String, RequestOptions) Method

Definition

Namespace:

Azure.Analytics.Purview.Scanning

Assembly:

Azure.Analytics.Purview.Scanning.dll

Package:

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

Source:

PurviewScanningServiceClient.cs

Get a scan ruleset.

public virtual Azure.Response GetScanRuleset (string scanRulesetName, Azure.RequestOptions options);

abstract member GetScanRuleset : string * Azure.RequestOptions -> Azure.Response
override this.GetScanRuleset : string * Azure.RequestOptions -> Azure.Response

Public Overridable Function GetScanRuleset (scanRulesetName As String, options As RequestOptions) As Response

Parameters

scanRulesetName

String

The String to use.

options

Azure.RequestOptions

The request options.

Returns

Response

Exceptions

ArgumentNullException

scanRulesetName is null.

Remarks

Schema for Response Body:

{
              scanRulesetType: "Custom" | "System",
              status: "Enabled" | "Disabled",
              version: number,
              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"
            }

Schema for Response Error:

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