Set-AzSynapseSqlPoolTransparentDataEncryption

Module:

Az.Synapse

Modifies TDE property for a SQL pool.

Syntax

Set-AzSynapseSqlPoolTransparentDataEncryption
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -Name <String>
   -State <TransparentDataEncryptionStateType>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlPoolTransparentDataEncryption
   -Name <String>
   -WorkspaceObject <PSSynapseWorkspace>
   -State <TransparentDataEncryptionStateType>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlPoolTransparentDataEncryption
   -InputObject <PSSynapseSqlPool>
   -State <TransparentDataEncryptionStateType>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlPoolTransparentDataEncryption
   -ResourceId <String>
   -State <TransparentDataEncryptionStateType>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzSynapseSqlPoolTransparentDataEncryption cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure Synapse Analytics SQL pool.

Examples

Example 1

Set-AzSynapseSqlPoolTransparentDataEncryption -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -State Enabled

This command enables TDE for the 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

-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

-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

-State

The Azure Synapse Analytics Sql Pool Transparent Data Encryption state.

Type:	TransparentDataEncryptionStateType
Accepted values:	Enabled, Disabled
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

-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

PSTransparentDataEncryption