Update-AzSynapseSqlAdvancedThreatProtectionSetting
Updates an advanced threat protection settings on a workspace.
Syntax
Update-AzSynapseSqlAdvancedThreatProtectionSetting
[-ResourceGroupName <String>]
-WorkspaceName <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>] 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
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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
Defines whether to email administrators.
| Type: | Nullable<T>[Boolean] |
| Aliases: | EmailAdmins |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedDetectionType
Detection types to exclude.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
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 |
-NotificationRecipientsEmail
A semicolon separated list of email addresses to send the alerts to.
| Type: | String |
| Aliases: | NotificationRecipientsEmails |
| 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 workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetentionInDays
The number of retention days for the audit logs.
| Type: | Nullable<T>[UInt32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageAccountName
The name of the storage account.
| 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 |
