Enable-AzSynapseSqlAdvancedDataSecurity

Reference

Module:: Az.Synapse

Enables Advanced Data Security on a workspace.

Syntax

Enable-AzSynapseSqlAdvancedDataSecurity
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      [-DoNotConfigureVulnerabilityAssessment]
      [-DeploymentName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzSynapseSqlAdvancedDataSecurity
      -InputObject <PSSynapseWorkspace>
      [-DoNotConfigureVulnerabilityAssessment]
      [-DeploymentName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Enable-AzSynapseSqlAdvancedDataSecurity
      -ResourceId <String>
      [-DoNotConfigureVulnerabilityAssessment]
      [-DeploymentName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AzSynapseSqlAdvancedDataSecurity cmdlet enables Advanced Data Security on a workspace. Advanced Data Security is a unified security package that includes Data Classification, Vulnerability Assessment and Advanced Threat Protection for your workspace. (A new storage account will automatically be created for saving vulnerability assessments. If a storage account was previously created for this purpose, it will be used instead)

Examples

Example 1

Enable-AzSynapseSqlAdvancedDataSecurity -WorkspaceName ContosoWorkspace

This command enables workspace Advanced Data Security.

Example 2

Get-AzSynapseWorkspace -Name ContosoWorkspace | Enable-AzSynapseSqlAdvancedDataSecurity

This command enables workspace Advanced Data Security through pipeline.

Example 3

Enable-AzSynapseSqlAdvancedDataSecurity -WorkspaceName ContosoWorkspace -DoNotConfigureVulnerabilityAssessment

This command enables workspace Advanced Data Security through pipeline and does not auto enable Vulnerability Assessment.

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

-DeploymentName

Supply a custom name for Advanced Data Security deployment.

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

-DoNotConfigureVulnerabilityAssessment

Do not auto enable Vulnerability Assessment (This will not create a storage account).

Type:	SwitchParameter
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

-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

-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

Inputs

PSSynapseWorkspace

Outputs

WorkspaceAdvancedDataSecurityPolicy