Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

  • Reference
Module:
Az.Synapse

Gets the vulnerability assessment rule baseline.

Syntax

Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline
   [-WorkspaceName] <String>
   [-Name] <String>
   [-InputObject <PSSynapseSqlPool>]
   -RuleId <String>
   [-RuleAppliesToMaster]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline cmdlet gets the vulnerability assessment rule baseline. Note that you need to run Enable-AzSynapseSqlAdvancedDataSecurity and Update-AzSynapseSqlVulnerabilityAssessmentSetting cmdlets as a prerequisite for using this cmdlet.

Examples

Example 1: Get the vulnerability assessment rule baseline

Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline `
            -ResourceGroupName "ContosoResourceGroup" `
            -WorkspaceName "ContosoWorkspace" `
            -SqlPoolName "ContosoSqlPool" `
            -RuleId "VA2108" `
            -RuleAppliesToMaster

ResourceGroupName		: ContosoResourceGroup
WorkspaceName	        	: ContosoWorkspace
SqlPoolName	    	: ContosoSqlPool
RuleId		        	: VA2108
RuleAppliesToMaster    	: True
BaselineResult		    : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None')  , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None')

Example 2: Get the vulnerability assessment rule baseline from a SQL pool object

Get-AzSynapseSqlPool `
            -ResourceGroupName "ContosoResourceGroup" `
            -WorkspaceName "ContosoWorkspace" `
            -Name "ContosoSqlPool" `
            | Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline `
                -RuleId "VA2108"

ResourceGroupName		: ContosoResourceGroup
WorkspaceName	        	: ContosoWorkspace
SqlPoolName	    	: ContosoSqlPool
RuleId		        	: VA2108
RuleAppliesToMaster    	: False
BaselineResult		    : @( 'Principal1', 'db_ddladmin', 'SQL_USER', 'None')  , @( 'Principal2', 'db_ddladmin', 'SQL_USER', 'None')

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

SQL pool input object, usually passed through the pipeline.

Type:PSSynapseSqlPool
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Name of Synapse SQL pool.

Type:String
Aliases:SqlPoolName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RuleAppliesToMaster

Specifies whether the baseline results should apply on a workspace level rule identified by the RuleId

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RuleId

The rule ID which identifies the rule to set the baseline results to.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

PSSynapseSqlPool

SwitchParameter

Outputs

SqlPoolVulnerabilityAssessmentRuleBaselineModel