Edit

Share via


Get-AzPurviewSystemScanRuleset

Get a system scan ruleset for a data source

Syntax

List (Default)

Get-AzPurviewSystemScanRuleset
    -Endpoint <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get1

Get-AzPurviewSystemScanRuleset
    -Endpoint <String>
    -Version <Int32>
    [-DataSourceType <DataSourceType>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzPurviewSystemScanRuleset
    -Endpoint <String>
    -DataSourceType <DataSourceType>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a system scan ruleset for a data source

Examples

Example 1: Get all system scanrulesets

Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/
Id                : systemscanrulesets/AmazonMySql
Kind              : AmazonMySql
Name              : AmazonMySql
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 2

Id                : systemscanrulesets/AzureMySql
Kind              : AzureMySql
Name              : AzureMySql
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 2

Id                : systemscanrulesets/AmazonPostgreSql
Kind              : AmazonPostgreSql
Name              : AmazonPostgreSql
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 2

Id                : systemscanrulesets/Teradata
Kind              : Teradata
Name              : Teradata
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 1

Get all system scanrulesets

Example 2: Get system scanruleset for a data source type

Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/  -DataSourceType 'AdlsGen2'
Id                : systemscanrulesets/AdlsGen2
Kind              : AdlsGen2
Name              : AdlsGen2
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 3

Get system scanruleset for a data source type

Example 3: Get system scanruleset for a data source type and specific version

Get-AzPurviewSystemScanRuleset -Endpoint https://parv-brs-2.purview.azure.com/  -DataSourceType 'AdlsGen2' -Version 2
Id                : systemscanrulesets/AdlsGen2
Kind              : AdlsGen2
Name              : AdlsGen2
ResourceGroupName :
Status            : Enabled
Type              : System
Version           : 2

Get system scanruleset for a data source type and specific version

Parameters

-DataSourceType

.

Parameter properties

Type:DataSourceType
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Endpoint

The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Version

.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

ISystemScanRuleset