Edit

Share via

Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord

Module:
Az.Synapse Module

Gets all vulnerability assessment scan record(s) associated with a given sql pool.

Syntax

GetBySqlPoolObjectParameterSet (Default) 

Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord
    [-ScanId <String>]
    [-SqlPoolObject <PSSynapseSqlPool>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByNameParameterSet 

Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord
    -WorkspaceName <String>
    -Name <String>
    [-ResourceGroupName <String>]
    [-ScanId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord cmdlet retrieves all vulnerability assessment scan record(s) associated with a given managed sql pool. Note that you need to run Enable-AzSynapseSqlAdvancedThreatProtection and Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet as a prerequisite for using this cmdlets.

Examples

Example 1 - Gets a specific vulnerability assessment scan results identified by the scan ID

Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01" `
            -ScanId "myScan"

ResourceGroupName	        	: ResourceGroup01
WorkspaceName	                : WorkspaceName01
Name		                    : Name01
ScanId 		                	: myScan
TriggerType	                	: OnDemand
State 			                : Passed
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 2 - Gets a specific vulnerability assessment scan results identified by the scan ID with sql pool object

Get-AzSynapseSqlPool `
            -ResourceGroupName "ResourceGroup01" `
            -WorkspaceName "WorkspaceName01" `
            -Name "Name01" `
            | Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord  `
                -ScanId "myScan"

ResourceGroupName	        	: ResourceGroup01
WorkspaceName	                : WorkspaceName01
Name		                    : Name01
ScanId 		                	: myScan
TriggerType	                	: OnDemand
State 			                : Passed
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 3 - Gets all vulnerability assessment scan results on the specified sql pool

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

ResourceGroupName	        	: ResourceGroup01
WorkspaceName	                : WorkspaceName01
Name		                    : Name01
ScanId 		                	: myScan
TriggerType	                	: OnDemand
State 			                : Passed
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		                    : Name01
ScanId 		                	: myScan1
TriggerType	                	: OnDemand
State 			                : Passed
StartTime 	                	: 6/12/2018 1:57:27 PM
EndTime 	            		: 6/12/2018 1:57:31 PM
Errors 		                	: {}
ScanResultsLocationPath     	: https://myaccount.blob.core.windows.net/vulnerability-assessment
                                    scans/WorkspaceName01/Name01/scan_myScan/.json
NumberOfFailedSecurityChecks    : 9

Parameters

-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

GetByNameParameterSet
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

GetByNameParameterSet
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

(All)
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

GetBySqlPoolObjectParameterSet
Position:Named
Mandatory:False
Value from pipeline:True
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

GetByNameParameterSet
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.VulnerabilityAssessment.PSVulnerabilityAssessmentScanRecordModel