Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting

  • Reference
Module:
Az.Synapse

Updates the vulnerability assessment settings of a SQL pool.

Syntax

Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      -Name <String>
      [-StorageAccountName <String>]
      [-ScanResultsContainerName <String>]
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      -Name <String>
      -BlobStorageSasUri <Uri>
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -Name <String>
      -WorkspaceObject <PSSynapseWorkspace>
      [-StorageAccountName <String>]
      [-ScanResultsContainerName <String>]
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -Name <String>
      -WorkspaceObject <PSSynapseWorkspace>
      -BlobStorageSasUri <Uri>
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -InputObject <PSSynapseSqlPool>
      [-StorageAccountName <String>]
      [-ScanResultsContainerName <String>]
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -InputObject <PSSynapseSqlPool>
      -BlobStorageSasUri <Uri>
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -ResourceId <String>
      [-StorageAccountName <String>]
      [-ScanResultsContainerName <String>]
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
      -ResourceId <String>
      -BlobStorageSasUri <Uri>
      [-RecurringScansInterval <RecurringScansInterval>]
      [-EmailAdmin <Boolean>]
      [-NotificationEmail <String[]>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting cmdlet updates the vulnerability assessment settings of an Azure Synapse Analytics SQL pool. Note that you need to run Enable-AzSynapseSqlAdvancedDataSecurity cmdlet as a prerequisite for using this cmdlet.

Examples

Example 1

Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -StorageAccountName "mystorage" `
            -ScanResultsContainerName "vulnerability-assessment" -RecurringScansInterval Weekly -EmailAdmin $true `
            -NotificationEmail @("mail1@mail.com","mail2@mail.com")

This command updates Vulnerability Assessment settings with storage account name.

Example 2

Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool `
            -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" `
            -RecurringScansInterval Weekly -EmailAdmin $true `
            -NotificationEmail @("mail1@mail.com","mail2@mail.com")

This command updates Vulnerability Assessment settings with blob storage SAS URI.

Parameters

-AsJob

Run cmdlet in the background

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

-BlobStorageSasUri

A SAS URI to a storage container that will hold the scan results.

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

-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

-EmailAdmin

A value indicating whether to email service and co-administrators on recurring scan completion.

Type:Boolean
Aliases:EmailAdmins
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

SQL pool input object, usually passed through the pipeline.

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

-Name

Name of Synapse SQL pool.

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

-NotificationEmail

A list of mail addresses to send on recurring scan completion.

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

-RecurringScansInterval

The recurring scans interval.

Type:RecurringScansInterval
Accepted values:None, Weekly
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse SQL Pool.

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

-ScanResultsContainerName

The name of the storage container that will hold the scan results.

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

-StorageAccountName

The name of the storage account that will hold the scan results.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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:False
Accept wildcard characters:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

PSSynapseSqlPool

Outputs

SqlPoolVulnerabilityAssessmentSettingsModel