Update-AzSynapseSqlAdvancedThreatProtectionSetting
Updates an advanced threat protection settings on a workspace.
Syntax
UpdateByNameParameterSet (Default)
Update-AzSynapseSqlAdvancedThreatProtectionSetting
-WorkspaceName <String>
[-ResourceGroupName <String>]
[-NotificationRecipientsEmail <String>]
[-EmailAdmin <Boolean>]
[-ExcludedDetectionType <String[]>]
[-StorageAccountName <String>]
[-RetentionInDays <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzSynapseSqlAdvancedThreatProtectionSetting
-InputObject <PSSynapseWorkspace>
[-NotificationRecipientsEmail <String>]
[-EmailAdmin <Boolean>]
[-ExcludedDetectionType <String[]>]
[-StorageAccountName <String>]
[-RetentionInDays <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateByResourceIdParameterSet
Update-AzSynapseSqlAdvancedThreatProtectionSetting
-ResourceId <String>
[-NotificationRecipientsEmail <String>]
[-EmailAdmin <Boolean>]
[-ExcludedDetectionType <String[]>]
[-StorageAccountName <String>]
[-RetentionInDays <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzSynapseSqlAdvancedThreatProtectionSetting cmdlet updates an advanced threat protection settings on an Azure Synapse Analytics Workspace. In order to enable advanced threat protection on a workspace an auditing settings must be enabled on that workspace.
Examples
Example 1
Update-AzSynapseSqlAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -NotificationRecipientsEmail "admin01@contoso.com;secadmin@contoso.com" -EmailAdmin $False -ExcludedDetectionType "Sql_Injection_Vulnerability","SQL_Injection" -StorageAccountName "mystorageAccount"
This command updates the advanced threat protection settings for a workspace named ContosoWorkspace.
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
-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
Defines whether to email administrators.
Parameter properties
Type: Nullable<T> [ 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
-ExcludedDetectionType
Detection types to exclude.
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
workspace input object, usually passed through the pipeline.
UpdateByInputObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-NotificationRecipientsEmail
A semicolon separated list of email addresses to send the alerts to.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: NotificationRecipientsEmails
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
UpdateByNameParameterSet
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 workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RetentionInDays
The number of retention days for the audit logs.
Parameter properties
Parameter sets
(All)
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.
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
-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
UpdateByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False 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
