Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting

Reference

Module:: Az.Synapse

Sets a advanced threat protection settings on a SQL pool.

Syntax

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      -Name <String>
      [-NotificationRecipientsEmail <String>]
      [-EmailAdmin <Boolean>]
      [-ExcludedDetectionType <String[]>]
      [-StorageAccountName <String>]
      [-RetentionInDays <UInt32>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting
      -Name <String>
      -WorkspaceObject <PSSynapseWorkspace>
      [-NotificationRecipientsEmail <String>]
      [-EmailAdmin <Boolean>]
      [-ExcludedDetectionType <String[]>]
      [-StorageAccountName <String>]
      [-RetentionInDays <UInt32>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting
      -InputObject <PSSynapseSqlPool>
      [-NotificationRecipientsEmail <String>]
      [-EmailAdmin <Boolean>]
      [-ExcludedDetectionType <String[]>]
      [-StorageAccountName <String>]
      [-RetentionInDays <UInt32>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting
      -ResourceId <String>
      [-NotificationRecipientsEmail <String>]
      [-EmailAdmin <Boolean>]
      [-ExcludedDetectionType <String[]>]
      [-StorageAccountName <String>]
      [-RetentionInDays <UInt32>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting cmdlet sets a advanced threat protection settings on an Azure Synapse Analytics SQL pool. In order to enable advanced threat protection on a SQL pool an auditing settings must be enabled on that SQL pool.

Examples

Example 1

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" -StorageAccountName "mystorageAccount"

This command sets the advanced threat protection settings for a SQL pool named ContosoSqlPool under the 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

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
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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 SQL Pool.

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

-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

PSSqlPoolSecurityAlertPolicy