Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

Module:

Az.Synapse Module

Clears the vulnerability assessment rule baseline.

Syntax

Default (Default)

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

Description

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

Examples

Example 1: Clears the vulnerability assessment rule baseline

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

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

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, 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

-InputObject

SQL pool input object, usually passed through the pipeline.

Parameter properties

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

Parameter sets

(All)

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

-Name

Name of Synapse SQL pool.

Parameter properties

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

Parameter sets

(All)

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

-ResourceGroupName

Resource group name.

Parameter properties

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

Parameter sets

(All)

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

-RuleAppliesToMaster

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

Parameter properties

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

Parameter sets

(All)

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

-RuleId

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

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:	True
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

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

-WorkspaceName

Name of Synapse workspace.

Parameter properties

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

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
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.

Inputs

String

PSSynapseSqlPool

SwitchParameter

Outputs

SqlPoolVulnerabilityAssessmentRuleBaselineModel