Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan

Module:

Az.Synapse Module

Converts a vulnerability assessment scan results to Excel format.

Syntax

ConvertByInputObjectParameterSet (Default)

Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan
    [-InputObject <PSVulnerabilityAssessmentScanRecordModel>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ConvertByNameParameterSet

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

Description

The Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan cmdlet converts a scan results, that resides in the customer storage, identified by the ScanId parameter to an Excel format placed in the storage Note that you need to run Enable-AzSynapseSqlAdvancedThreatProtection and Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet as a prerequisite for using this cmdlets.

Examples

Example 1: Converts vulnerability assessment scan results and saves them to local disk

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

$convert_scan_results = Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan `
									-ResourceGroupName "ResourceGroup01" `
									-WorkspaceName "WorkspaceName01" `
									-Name "Name01" `
									-ScanId "myScan"

ResourceGroupName		: "ResourceGroup01"
WorkspaceName		    : "WorkspaceName01"
Name	    	        : "Name01"
ScanId			        : "myScan"
ExportedReportLocation	: "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/WorkspaceName01/Name01/scan_myScan.xlsx"

Example 2: Converts a vulnerability assessment scan results from a scan record

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

ResourceGroupName		: "ResourceGroup01"
WorkspaceName		    : "WorkspaceName01"
Name	    	        : "Name01"
ScanId			        : "myScan"
ExportedReportLocation	: "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/WorkspaceName01/Name01
                            /scan_myScan.xlsx"

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

The scan record object to use in order to convert a Vulnerability Assessment scan.

Parameter properties

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

Parameter sets

ConvertByInputObjectParameterSet

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

Parameter sets

ConvertByNameParameterSet

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

ConvertByNameParameterSet

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

ConvertByNameParameterSet

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

ConvertByNameParameterSet

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

String

Microsoft.Azure.Commands.Synapse.Models.PSVulnerabilityAssessmentScanRecordModel

Outputs

PSVulnerabilityAssessmentScanExportModel