Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan

Reference

Module:: Az.Synapse

Converts a vulnerability assessment scan results to Excel format.

Syntax

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

Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan
       [-ResourceGroupName <String>]
       -WorkspaceName <String>
       -Name <String>
       -ScanId <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.

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

-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

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

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

-Name

Name of Synapse SQL pool.

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

-ResourceGroupName

The name of the resource group.

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

-ScanId

Specifies the scan ID.

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

-WhatIf

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

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

-WorkspaceName

Name of Synapse workspace.

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

Inputs

String

Microsoft.Azure.Commands.Synapse.Models.PSVulnerabilityAssessmentScanRecordModel

Outputs

PSVulnerabilityAssessmentScanExportModel