Edit

Share via

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan

Module:
Az.Synapse Module

Starts a vulnerability assessment scan.

Syntax

StartSqlPoolObjectParameterSet (Default) 

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan
    [-SqlPoolObject <PSSynapseSqlPool>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

StartSqlPoolNameParameterSet 

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan
    -WorkspaceName <String>
    -Name <String>
    [-ResourceGroupName <String>]
    [-ScanId <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Start-AzSynapseSqlPoolVulnerabilityAssessmentScan cmdlet triggers a scan with ScanId identifier. Scan results will be saved under the storage defined by the Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet, under scans/{WorkspaceName}/{Name}/scan_{ScanId}.json You can monitor the progress of the scan by using the Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord cmdlet with the scanId parameter and look at the State returned parameter. Note that you need to run Enable-AzSynapseSqlAdvancedThreatProtection and Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet as a prerequisite for using this cmdlets.

Examples

Example 1: Starts a vulnerability assessment scan

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01" `
            -ScanId "myScan"

ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name01
ScanId                       : myScan
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Error                        : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name01/scan_myScan.json
NumberOfFailedSecurityChecks : 9

Example 2: Starts a vulnerability assessment scan without a specific scan ID

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01"

ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name01
ScanId                       : 20180611_135726
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Errors                       : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name01/scan_myScan.json
NumberOfFailedSecurityChecks : 9

This command generates a scan ID in the format of "yyyyMMdd_HHmmss" from the UTC date time.

Example 3: Starts a vulnerability assessment scan in the background

$scanJob = Start-AzSynapseSqlPoolVulnerabilityAssessmentScan `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01" `
            -ScanId "myScan" `
            -AsJob
$scanJob | Wait-Job
$scanJob | Receive-Job

ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name01
ScanId                       : myScan
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Errors                       : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name01/scan_myScan.json
NumberOfFailedSecurityChecks : 9

Example 4: Starts a vulnerability assessment scan with a managed sql pool object

Get-AzSynapseSqlPool `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01" `
            | Start-AzSynapseSqlPoolVulnerabilityAssessmentScan

ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name01
ScanId                       : 20180611_135726
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Errors                       : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name01/scan_myScan.json
NumberOfFailedSecurityChecks : 9

Example 5: Starts a vulnerability assessment scan on all the databases under a managed instance

Get-AzSynapseSqlPool `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            | Where-Object {$_.Name -ne "master"}  `
            | Start-AzSynapseSqlPoolVulnerabilityAssessmentScan

ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name01
ScanId                       : 20180611_135726
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Errors                       : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name01/scan_myScan.json
NumberOfFailedSecurityChecks : 9


ResourceGroupName            : ResourceGroup01
WorkspaceName                : WorkspaceName01
Name                         : Name02
ScanId                       : 20180611_135726
TriggerType                  : OnDemand
State                        : Fail
StartTime                    : 6/11/2018 1:57:27 PM
EndTime                      : 6/11/2018 1:57:31 PM
Errors                       : {}
ScanResultsLocationPath      : https://myaccount.blob.core.windows.net/vulnerability-assessment
                                scans/WorkspaceName01/Name02/scan_myScan.json
NumberOfFailedSecurityChecks : 9

Parameters

-AsJob

Run cmdlet in the background

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

-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

-Name

Name of Synapse SQL pool.

Parameter properties

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

Parameter sets

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

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

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

-ScanId

Specifies the scan ID.

Parameter properties

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

Parameter sets

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

-SqlPoolObject

The sql pool object to get Vulnerability Assessment scan record for

Parameter properties

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

Parameter sets

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

StartSqlPoolNameParameterSet
Position:Named
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

PSSynapseSqlPool

String

Outputs

Microsoft.Azure.Commands.Synapse.Models.PSSynapseSqlPool.PSVulnerabilityAssessmentScanRecordModel