Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
Updates the vulnerability assessment settings of a SQL pool.
Syntax
UpdateByStorageAccountNameAndNameParameterSet (Default)
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
-WorkspaceName <String>
-Name <String>
[-ResourceGroupName <String>]
[-StorageAccountName <String>]
[-ScanResultsContainerName <String>]
[-RecurringScansInterval <RecurringScansInterval>]
[-EmailAdmin <Boolean>]
[-NotificationEmail <String[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateByBlobStorageSasUriAndNameParameterSet
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
-WorkspaceName <String>
-Name <String>
-BlobStorageSasUri <Uri>
[-ResourceGroupName <String>]
[-RecurringScansInterval <RecurringScansInterval>]
[-EmailAdmin <Boolean>]
[-NotificationEmail <String[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateByStorageAccountNameAndParentObjectParameterSet
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
-Name <String>
-WorkspaceObject <PSSynapseWorkspace>
[-StorageAccountName <String>]
[-ScanResultsContainerName <String>]
[-RecurringScansInterval <RecurringScansInterval>]
[-EmailAdmin <Boolean>]
[-NotificationEmail <String[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateByBlobStorageSasUriAndParentObjectParameterSet
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>]
UpdateByStorageAccountNameAndResourceIdParameterSet
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting
-ResourceId <String>
[-StorageAccountName <String>]
[-ScanResultsContainerName <String>]
[-RecurringScansInterval <RecurringScansInterval>]
[-EmailAdmin <Boolean>]
[-NotificationEmail <String[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateByBlobStorageSasUriAndResourceIdParameterSet
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
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
-BlobStorageSasUri
A SAS URI to a storage container that will hold the scan results.
Parameter properties
Type: Uri
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByBlobStorageSasUriAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndInputObjectParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndResourceIdParameterSet
Position: Named Mandatory: True 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
-EmailAdmin
A value indicating whether to email service and co-administrators on recurring scan completion.
Parameter properties
Type: Boolean
Default value: None Supports wildcards: False DontShow: False Aliases: EmailAdmins
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SQL pool input object, usually passed through the pipeline.
Type: PSSynapseSqlPool
Default value: None Supports wildcards: False DontShow: False
UpdateByStorageAccountNameAndInputObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndInputObjectParameterSet
Position: Named Mandatory: True 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 Aliases: SqlPoolName
Parameter sets
UpdateByStorageAccountNameAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NotificationEmail
A list of mail addresses to send on recurring scan completion.
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: False Value from remaining arguments: False
-RecurringScansInterval
The recurring scans interval.
Parameter properties
Type: RecurringScansInterval
Default value: None Accepted values: None, Weekly 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
-ResourceGroupName
Resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByStorageAccountNameAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
Resource identifier of Synapse SQL Pool.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByStorageAccountNameAndResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScanResultsContainerName
The name of the storage container that will hold the scan results.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByStorageAccountNameAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndParentObjectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndInputObjectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StorageAccountName
The name of the storage account that will hold the scan results.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByStorageAccountNameAndNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndParentObjectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndInputObjectParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByStorageAccountNameAndResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False 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
UpdateByStorageAccountNameAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
Parameter sets
UpdateByStorageAccountNameAndParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateByBlobStorageSasUriAndParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False 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 .
Outputs
